List API keys

GET/v1/api-keys

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsAPIKeyItem[] | nullrequired

Show properties

Array of APIKeyItem

created_atstringrequired

created_bystringrequired

expires_atstring | nullrequired

idstringrequired

is_activebooleanrequired

key_prefixstringrequired

namestringrequired

scopesanyrequired

metaPaginationMetarequired

Show properties

cursorstring

has_morebooleanrequired

limitinteger<int64>required

next_cursorstring

offsetinteger<int64>

totalinteger<int64>

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/api-keys"

const response = await fetch("/v1/api-keys", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/api-keys",
)

Response

{
  "items": [
    {
      "created_at": "string",
      "created_by": "string",
      "expires_at": "string",
      "id": "string",
      "is_active": true,
      "key_prefix": "string",
      "name": "string",
      "scopes": "string"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}