OverviewPlatformsAPI Reference
API Keys

List API keys

Lists the workspace's active keys, latest first, with name, prefix, scope, expiry and last use. Revoked keys and secrets are never listed.

GET
/v1/api-keys

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/api-keys"
{  "data": [    {      "id": "string",      "name": "string",      "prefix": "string",      "scope": "read",      "createdAt": "string",      "lastUsedAt": "string",      "expiresAt": "string"    }  ]}
Was this page helpful?

Create an API key

Issues a new API key in this workspace. The key is shown only in this response, and only its hash is stored. `expiresAt` makes it stop working at a set time, useful for a contractor or a one-off script. An expired key stays in the list until you revoke it.

Revoke an API key

Revokes the key. The API refuses it right away, and cached checks catch up within a few minutes.