API keys

List API keys

List all API keys for the authenticated owner.

GET/api-keys

List all API keys for a specific owner. Use this endpoint to audit and manage your API keys. Note that the actual API key value is not returned for security reasons.

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

Query

ownerstringquery

Unique identifier of the owner whose keys you want to list.

Response

Returns an array of API key objects. Note that the actual key value is not returned for security reasons.

api_key_idstring

Unique identifier for the API key.

namestring

The name of the API key.

owner_idstring

The owner identifier associated with the API key.

scopesarray

List of permissions granted to the API key.

expires_atstring

The expiration date and time for the API key in ISO 8601 format.

created_atstring

ISO 8601 formatted timestamp of when the API key was created.

last_used_atstring

ISO 8601 formatted timestamp of when the API key was last used for authentication.

curl -X GET "http://localhost:5001/api-keys?owner=owner_id" \
  -H "X-blnk-key: <api-key>"

[
  {
    "api_key_id": "key_abc123def456",
    "name": "Service Account",
    "owner_id": "owner_id",
    "scopes": ["ledgers:read", "balances:write"],
    "expires_at": "2026-03-11T00:00:00Z",
    "created_at": "2024-01-15T10:30:00Z",
    "last_used_at": "2024-01-20T14:30:00Z"
  },
  {
    "api_key_id": "key_xyz789uvw012",
    "name": "Production API",
    "owner_id": "owner_id",
    "scopes": ["*:*"],
    "expires_at": "0001-01-01T00:00:00Z",
    "created_at": "2024-01-10T08:20:00Z",
    "last_used_at": "2024-01-19T10:15:00Z"
  }
]

{
  "error": "owner is required",
  "error_detail": {
    "code": "APIKEY_OWNER_REQUIRED",
    "message": "owner is required"
  }
}