Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →

List API keys

GET

/v1/api-keys

const url = 'http://localhost:8080/v1/api-keys?limit=50&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:8080/v1/api-keys?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Returns the newest 50 keys in the caller’s mode (test or live), newest first. Revoked and expired keys are included; check revoked_at and expires_at. Key values are never returned. There are no paging parameters and no total.

Authorizations

BearerAuth

Parameters

Query Parameters

limit

integer

default: 50 >= 1 <= 100

Rows per page, from 1 to 100. Default 50. Any other value, or one that is not a whole number, is a 422 with param: limit.

offset

integer

Rows to skip, 0 or more. Default 0. A negative value, or one that is not a whole number, is a 422 with param: offset.

Responses

200

Key list

application/json

object

data

required

Array<object>

object

required

string

key_prefix

required

The start of the key (type, mode and a few characters), enough to tell keys apart. Never the full key.

string

key_type

required

string

Allowed values: platform secret

livemode

required

boolean

name

required

string

tenant_id

required

string

created_at

required

string format: date-time

expires_at

When the key stops working. Also set on the old key during a rotation grace period.

string format: date-time

revoked_at

string format: date-time

last_used_at

Updated at most about once per interval, so it can lag a little.

string format: date-time

total

required

How many rows match the request’s filters, on every page, not only this one. The audit log and the customer list’s search and name or email sort say where they stop counting.

integer

Example

{
  "data": [
    {
      "id": "hc_key_1a2b3c4d5e6f7890",
      "key_prefix": "hc_secret_test_1a2b3c4d",
      "key_type": "platform"
    }
  ]
}

403

Caller lacks the apikey:write permission

application/json

object

error

object

type

One of invalid_request_error, authentication_error, rate_limit_error or api_error. Every error the API answers has this shape, including an unknown path (404, code route_not_found) and a method the path does not take (405, code method_not_allowed, with an Allow header). The few exceptions are listed in docs/api-surface.md.

string

code

string

message

string

request_id

string

param

The request field the error is about. Sent only when the error names one. A request body may hold only the fields its operation lists, spelled and cased as listed: any other field, or one the server sets (such as id), is refused with 422 and param naming it. An operation with no request body lists no fields: send no body, {} or null. The Stripe and Postmark webhooks and the LiteLLM callback take their sender’s body as it comes.

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

422

limit or offset is out of range or not a whole number, or the request sends the removed after cursor (param names it)

application/json

object

error

object

type

string

code

string

message

string

request_id

string

param

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}