API Reference

Admin

Organization

Admin API Keys

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve admin API key

client.admin.organization.adminAPIKeys.retrieve(stringkeyID, RequestOptionsoptions?): AdminAPIKey { id, created_at, object, 4 more }

GET/organization/admin_api_keys/{key_id}

Retrieve a single organization API key

ParametersExpand Collapse

keyID: string

The ID of the API key.

ReturnsExpand Collapse

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: number

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?: number

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?: number | null

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

formatunixtime

name?: string | null

The name of the API key

Retrieve admin API key

TypeScript

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

import OpenAI from 'openai';

const client = new OpenAI({
  adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted
});

const adminAPIKey = await client.admin.organization.adminAPIKeys.retrieve('key_id');

console.log(adminAPIKey.id);

{
  "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"
  }
}