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-25",
      "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

Changed in 23 of the 74 revisions of this API.1316

  • 86b97292852d2See the full diff
    • ●

      added the new 2026-09-24-1 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new 2026-09-25 enum value to the // response property for the response status

      response-property-enum-value-added

  • c1dceb26e5051See the full diff
    • ●

      added the new 2026-09-24 enum value to the // response property for the response status

      response-property-enum-value-added

  • 7fcefabddb0a1See the full diff
    • ●

      added the new 2026-09-23 enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99665See the full diff
    • ●

      added the new 2026-09-22 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new 2026-09-22-1 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new 2026-09-22-2 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new 2026-09-22-3 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new 2026-09-22-4 enum value to the // response property for the response status

      response-property-enum-value-added

  • ff3a7657356313See the full diff
    • ▲

      for the query request parameter first, default value 20 was added

      request-parameter-default-value-added

    • ●

      for the query request parameter first, the max was set to 100.00

      request-parameter-max-set

    • ●

      for the query request parameter last, the max was set to 100.00

      request-parameter-max-set

    • ●

      added the new 2026-09-15 enum value to the // response property for the response status

      response-property-enum-value-added

  • c19acf2e25481See the full diff
    • ●

      added the new 2026-09-13 enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1660b8d622041See the full diff
    • ●

      added the new 2026-09-11-1 enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 918ff9d965e12See the full diff
    • ●

      added the new 2026-09-09-1 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new 2026-09-11 enum value to the // response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2a25564a92d51See the full diff
    • ●

      added the new 2026-09-09 enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4fe3b2d215461See the full diff
    • ●

      added the new 2026-09-06 enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.