Bitnob Black Logo

Overview

Metadata about the API key you're authenticating with — the owning organization, granted scopes, and usage timestamps. Call this on startup to confirm your credentials are valid and to check which scopes the key carries before attempting a scoped operation.

Get API Key Info

Use Case

Returns metadata about the authenticated API key, including the organization it belongs to and the scopes it has been granted. A 200 confirms the key is valid; inspect scopes to verify the key can perform the operations your integration needs.

Get API Key Info
Response Fields
1
objectstring

Always `api_key`.

2
idstring (uuid)

Identifier of the API key making the request.

3
namestring

Display name given to the key when it was created.

4
organization_idstring (uuid)

The organization the key belongs to. All resources the key can access are scoped to this organization.

5
scopesstring[]

Permission scopes granted to the key (e.g. `wallets:read`, `wallets:manage`, `transactions:manage`). Operations outside these scopes return `401`.

6
api_versionstring

API version the key is pinned to.

7
last_used_atstring (date-time)

RFC 3339 timestamp of the most recent request made with this key.

8
created_atstring (date-time)

RFC 3339 timestamp of when the key was created.

Get API Key Info Response
Did you find this page useful?