API Keys

Get Current API Key

Returns metadata about the API key used for the current request, including its type and scopes.

get/api-keys/current

Request

Response

Successful Response

idstring required

The API key's opaque identifier.

key_type'entity' | 'user' required
scopesApiKeyScope[] required

The scopes granted to this key, in order.

owner_emailstring nullable

Email address of the user who owns this key, when applicable.

Example response

{
  "id": "a_AEVN-4eFgihjZr8-BH3g",
  "key_type": "entity",
  "owner_entity": {
    "entity_id": "94a60dc7-93ab-4fed-8b2f-4008cdf7289b",
    "entity_name": "AMITY"
  },
  "scopes": [
    "accounts:read",
    "accounts:transactions",
    "transfers:book:write"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.