List organization and project API keys

3 parameters

afterstringoptional

A cursor containing the API key ID after which to continue the paginated results.

orderstringoptional

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

Allowed:ascdescDefault:asc

limitintegeroptional

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

Default:20

1 status code

200Returns a list object containing API key records, pagination metadata, and a `has_more` flag indicating whether additional keys are available.

objectstringrequired

Allowed:list

dataarray<object>required

has_morebooleanrequired

first_idstringoptional

last_idstringoptional

Error handling

order must be asc or desc, and defaults to asc when omitted. limit defaults to 20 when omitted, while after must contain an API key ID from the pagination order when supplied.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

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