Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Admin API Keys

Retrieve admin API key

admin.organization.admin_api_keys.retrieve(key_id) -> AdminAPIKey { id, created_at, object, 4 more }
GET/organization/admin_api_keys/{key_id}

Retrieve a single organization API key

ParametersExpand Collapse
key_id: String

The ID of the API key.

ReturnsExpand Collapse
class AdminAPIKey { id, created_at, object, 4 more }

Represents an individual Admin API key in an org.

id: String

The identifier, which can be referenced in API endpoints

created_at: Integer

The Unix timestamp (in seconds) of when the API key was created

formatunixtime
object: :"organization.admin_api_key"

The object type, which is always organization.admin_api_key

owner: Owner{ id, created_at, name, 3 more}
id: String

The identifier, which can be referenced in API endpoints

created_at: Integer

The Unix timestamp (in seconds) of when the user was created

formatunixtime
name: String

The name of the user

object: String

The object type, which is always organization.user

role: String

Always owner

type: String

Always user

redacted_value: String

The redacted value of the API key

last_used_at: Integer

The Unix timestamp (in seconds) of when the API key was last used

formatunixtime
name: String

The name of the API key

Retrieve admin API key

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

admin_api_key = openai.admin.organization.admin_api_keys.retrieve("key_id")

puts(admin_api_key)
{
  "object": "organization.admin_api_key",
  "id": "key_abc",
  "name": "Main Admin Key",
  "redacted_value": "sk-admin...xyz",
  "created_at": 1711471533,
  "last_used_at": 1711471534,
  "owner": {
    "type": "user",
    "object": "organization.user",
    "id": "user_123",
    "name": "John Doe",
    "created_at": 1711471533,
    "role": "owner"
  }
}
Returns Examples
{
  "object": "organization.admin_api_key",
  "id": "key_abc",
  "name": "Main Admin Key",
  "redacted_value": "sk-admin...xyz",
  "created_at": 1711471533,
  "last_used_at": 1711471534,
  "owner": {
    "type": "user",
    "object": "organization.user",
    "id": "user_123",
    "name": "John Doe",
    "created_at": 1711471533,
    "role": "owner"
  }
}