API keys

List API keys

List API keys for an owner with the TypeScript SDK.

GET/api-keys

Use blnk.ApiKeys.list to list API keys for an owner.

Call the method

const response = await blnk.ApiKeys.list({
  owner: 'merchant_a',
});

Field	Type	Description
`options.owner`	`string`	Owner whose keys to return. Required when authenticating with the master key.

Use the key list

Iterate over response.data to find keys by name, scopes, or expiration. Plaintext key values are not included in list results.

Response

[
  {
    "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"
  }
]

Field	Type	Description
`response.data`	`object[]`	Array of API key records without the plaintext key value.