API Keys

Get API Keys

Changed on
get/api_keys

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/api_keys
  • Auth: HTTP bearer

Query parameters

typestring
subjectstring required
include_invalid'true' | 'false'
limitnumber
offsetnumber nullable
querystring

Response

200 OK

total_countnumber required

Example response

{
  "data": [
    {
      "id": "ak_3beecc9c60adb5f9b850e91a8ee1e992",
      "type": "api_key",
      "subject": "user_2xhFjEI5X2qWRvtV13BzSj8H6Dk",
      "name": "MY_SERVICE_API_KEY",
      "description": "This is my API Key",
      "claims": {
        "foo": "bar"
      },
      "scopes": [
        "read",
        "write"
      ],
      "revocation_reason": "Revoked by user",
      "expiration": 1716883200,
      "created_by": "user_2xhFjEI5X2qWRvtV13BzSj8H6Dk",
      "last_used_at": 1716883200,
      "created_at": 1716883200,
      "updated_at": 1716883200
    }
  ]
}

Changes