Sign in
API Keys

List API Keys

Lists the API keys of an account or app, newest first. Responses never include the full secret — only its obfuscated form.

get/api_keys

Query parameters

resource_idstring required

The account (biz_) or app (app_) tag to list API keys for.

resource_type'account' | 'app' required

The type of resource that owns the API keys.

integer
OR
string

Only return API keys created before this ISO 8601 timestamp.

integer
OR
string

Only return API keys created after this ISO 8601 timestamp.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order'created_at'

The field to sort API keys by.

direction'asc' | 'desc'

Sort direction.

Response

api keys listed

Example response

{
  "data": [
    {
      "api_version_date": "2026-09-23",
      "created_at": "2026-01-01T12:00:00.000Z",
      "expires_at": "2026-01-01T12:00:00.000Z",
      "grants": [
        {
          "actions": [
            {
              "action": "ai_prompt:create"
            }
          ],
          "resource_id": "biz_xxxxxxxxxxxxxx",
          "resource_type": "account"
        }
      ],
      "id": "apik_xxxxxxxxxxxxxx",
      "ip_allowlist": [
        "203.0.113.0/24"
      ],
      "name": "Shine Time Booking (admin role)",
      "obfuscated_secret_key": "apik_xxxx....xxxx",
      "secret_key": "apik_xxxxxxxxxxxxxx_C0000_C_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "system_role": "admin",
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes