Retrieve an organization admin API key

1 parameter

key_idstringrequired

The identifier of the organization API key to retrieve.

1 status code

200Returns the requested API key's object type, identifier, name, redacted value, creation and usage timestamps, expiration state, and owner information.

objectstringrequired

The object type, which is always `organization.admin_api_key`

Allowed:organization.admin_api_key

idstringrequired

The identifier, which can be referenced in API endpoints

namestringoptional

The name of the API key

redacted_valuestringrequired

The redacted value of the API key

created_atintegerrequired

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

expires_atintegerrequired

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

last_used_atintegeroptional

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

ownerobjectrequired

Error handling

key_id must identify the organization API key you want to retrieve. Use the returned redacted_value and timestamp fields to inspect the key without exposing its full secret value.

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.get({ keyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

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

Request

Response

Errors