List API keys

Lists key metadata for the workspace. Requires api_keys:manage.

GET/api-keys

Authorization

AuthorizationBearer <token>

Query parameters

limitinteger

minimum: 1
maximum: 100
default: 50

afterstring

Response

application/json

API-key list

union

All of these rules apply

object1

object

objectstringrequired

const: "list"

dataarrayrequired

Show nested schema

Array items

any

has_morebooleanrequired

first_idstring | nullrequired

last_idstring | nullrequired

object2

object

dataarray

Show nested schema

Array items

object

idstringrequired

format: "uuid"

objectstringrequired

const: "api_key"

key_prefixstringrequired

keystring

Returned only when a key is created or rotated.

labelstring | null

scopesarrayrequired

Grants on this key. Active keys hold only canonical scopes; revoked keys keep the scopes they were issued with.

Show nested schema

Array items

string

modestringrequired

Always live for active keys. test appears only on revoked keys issued before test mode was removed.

enum: ["live","test"]

created_atintegerrequired

last_used_atinteger | null

revoked_atinteger | null

updated_atinteger

old_key_revokes_atstring

Returned only when a key is rotated.

format: "date-time"

curl --request GET \
  --url 'https://YOUR_SALAMBO_BASE_URL/api/v1/api-keys' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace placeholders with your values.

Response

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "api_key",
      "key_prefix": "<string>",
      "key": "<string>",
      "label": "<string | null>",
      "scopes": [
        "<string>"
      ],
      "mode": "live",
      "created_at": 123,
      "last_used_at": 123,
      "revoked_at": 123,
      "updated_at": 123,
      "old_key_revokes_at": "<string>"
    }
  ],
  "has_more": true,
  "first_id": "<string | null>",
  "last_id": "<string | null>"
}