API Reference · Account

List API Keys

API keys

GET/v1/api-keys

Account required

cURL example

cURL request

curl "https://api.verifiedinbox.ai/v1/api-keys" \
  -H "Authorization: Bearer vi_live_YOUR_API_KEY"

Parameters

Parameter	Type	Description
VI-Environmentheader	string	`live` (default) or `test`. Used for anonymous callers and OAuth access tokens; API keys and web sessions carry their own environment.

Response

200 OKKeys (no tokens).

application/json

Field	Type	Description
datarequired	ApiKey[]	— Nested fields (8) `created_at` (string (date-time)) `environment` (string) `id` (string (uuid)) `last_used_at` (string (date-time)) `name` (string) `prefix` (string): First characters of the token, for recognition. `revoked_at` (string (date-time)) `scopes` (string[])
next_cursorrequired	string \| null	Cursor for the next page, or null.

Example 200 response (ApiKeyList)

{
  "data": [
    {
      "created_at": "2026-10-31T12:00:00Z",
      "environment": "live",
      "id": "0192a5e0-1234-7000-8000-000000000001",
      "last_used_at": "2026-10-31T12:00:00Z",
      "name": "Acme Inc.",
      "prefix": "string",
      "revoked_at": "2026-10-31T12:00:00Z",
      "scopes": []
    }
  ],
  "next_cursor": "string"
}

Other responses & possible errors

Expand a status code below to see the error code, description, and example error payload.

401 (unauthenticated)`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

Example 401 error response

{
  "error": {
    "code": "unauthenticated",
    "message": "Sign in or provide an API key to continue.",
    "next_action": {
      "kind": "sign_in",
      "title": "Sign in or create an account",
      "url": "/login"
    }
  }
}

429 (rate_limited)`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

Example 429 error response

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait a moment and try again."
  }
}

Was it helpful?