Skip to main content
GET
/
api_keys
/
whoami
Describe the calling API key
curl --request GET \
  --url https://api.bridge.xyz/v0/api_keys/whoami \
  --header 'Api-Key: <api-key>'
{
  "id": "5f1f5b3a-8c2b-4e5f-9d88-e0b2a7d3a1e8",
  "type": "Private",
  "owner_type": "Developer",
  "owner_id": "e802b3a4-f453-4da8-8a5b-dd50cede1e4f",
  "prefix": "sk-live",
  "last_4": "9f2c",
  "state": "Active",
  "created_at": "2026-04-22T15:04:05Z",
  "updated_at": "2026-04-22T15:04:05Z",
  "scopes": [
    "customer:read",
    "customer:create"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.bridge.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Api-Key
string
header
required

Response

Metadata describing the calling API key.

​
id
string<uuid>
required

The unique identifier for this API key.

​
type
enum<string>
required

Whether the key was created programmatically (Private) or via the Dashboard (Public).

Available options:
Public,
Private
​
owner_type
enum<string>
required

The type of entity that owns the key. Always Developer.

Available options:
Developer
​
owner_id
string<uuid>
required

The developer ID that owns the key.

​
prefix
enum<string>
required

The environment prefix of the key. sk-live in production, sk-test in sandbox.

Available options:
sk-live,
sk-test
​
last_4
string
required

The last four characters of the key, shown alongside the prefix for disambiguation in audit logs.

​
state
enum<string>
required

Lifecycle state of the key.

Available options:
Active,
Deleted
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
scopes
string[]
required

The scopes authorized on this key. A single-element list containing bridge:api_unrestricted denotes an unrestricted key (all standard scopes). Any other list denotes a scoped key.