List API Keys

Retrieve all API keys for your organization

1 min read

get/api/v1/user/api-keys

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/user/api-keys \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

[
  {
    "id": 1,
    "name": "<string>",
    "key_prefix": "<string>",
    "is_active": true,
    "created_at": "2026-08-10T12:00:00Z",
    "last_used_at": "2026-08-10T12:00:00Z",
    "archived_at": "2026-08-10T12:00:00Z"
  }
]

get/api/v1/user/api-keys

The key field is never returned in list responses — only key_prefix (the first 8 characters) is shown for identification. To include archived keys, pass ?include_archived=true.

Query parameters

include_archivedboolean#

Default: false

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

idintegerrequired#

namestringrequired#

key_prefixstringrequired#

is_activebooleanrequired#

created_atstringrequired#

last_used_atstring · null#

Show child attributes

Any of

archived_atstring · null#

Show child attributes

Any of

Create API Key Archive API Key