ReferenceApi keys

List API keys

Key metadata only.

The secret itself is stored as a SHA-256 hash and is never returned by this endpoint.

GET
/api/v1/api-keys

Authorization

ApiKeyAuth
x-api-key<token>

A platform key (ck_live_…). Mint one in the console under Settings → API Keys.

In: header

Response Body

application/json

curl -X GET "https://example.com/api/v1/api-keys"
{  "keys": [    {      "key_id": "string",      "name": "string",      "prefix": "string",      "scopes": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "last_used_at": "2019-08-24T14:15:22Z",      "usage_count": 0,      "expires_at": "2019-08-24T14:15:22Z"    }  ]}
Was this page helpful?
Report an issue