List organization and project API keys | OpenAI API (unofficial showcase)

3 parameters

afterstringoptional

Key ID cursor; returns keys with IDs that follow this value in the pagination order.

orderstringoptional

Sort order by creation time: `asc` or `desc`. Defaults to `asc` when omitted.

Allowed:ascdescDefault:asc

limitintegeroptional

Maximum number of keys to return. Defaults to 20 when omitted.

Default:20

3 status codes

200Returns a list of organization API key objects with pagination metadata, including whether more results are available and the first and last IDs.

objectstringrequired

Allowed:list

dataarray<object>required

has_morebooleanrequired

first_idstringoptional

last_idstringoptional

400Returned when the API key listing parameters are invalid.

errorobjectrequired

403Returned when the caller does not have permission to perform this operation.

errorobjectrequired

Details about the permission error.

Error handling

A 400 is returned when the listing parameters are invalid. A 403 is returned when the caller does not have permission to list API keys. order must be asc or desc.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.adminApiKeys.list({
  after: "example",
  order: "example",
  limit: 20,
});

{
  "object": "list",
  "data": [
    {
      "object": "organization.admin_api_key",
      "id": "key_abc",
      "name": "Administration Key",
      "redacted_value": "sk-admin...def",
      "created_at": 1711471533,
      "expires_at": 1714063533,
      "last_used_at": 1711471534,
      "owner": {
        "type": "user",
        "object": "organization.user",
        "id": "sa_456",
        "name": "My Service Account",
        "created_at": 1711471533,
        "role": "owner"
      }
    }
  ],
  "has_more": false,
  "first_id": "key_abc",
  "last_id": "key_xyz"
}

Request

Response

Errors