Sign in
API Keys

List API Keys

Changed on

Returns all the API Keys given a filter

get/v1/api-keys

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

limitinteger nullable

Total amount of results to return

offsetinteger nullable

Offset where to start returning results

idsstring[] nullable

List of IDs

account_idstring uuid nullable

Owning account ID.

Account-scoped endpoints populate this from the authenticated account.

order_direction'Asc' | 'Desc'

Direction of result ordering for list endpoints.

Direction of the ordering of results

Response

Success

account_idstring uuid required

Owning account ID

created_atstring date-time required

Date of creation in database

descriptionstring nullable

API key description

expires_atstring date-time nullable

Date of expiration

idstring uuid required

Internal ID

keystring nullable

API key (only returned once on creation, save it securely as it cannot be retrieved)

namestring required

API key name

permissionsPermission[] required

List of permissions for this API key

Changes

  • 1fe5c61520ccRevision changes
    • warning

      added the new read:account enum value to the // response property for the response status

    • warning

      added the new write:account enum value to the // response property for the response status

  • 2aba664778fbRevision changes
    • breaking

      removed the required property / from the response with the status

    • warning

      deleted the query request parameter user_id

    • info

      added the new optional query request parameter account_id

    • info

      added the required property / to the response with the status