Skip to main content
GET
/
v1
/
admin
/
api-keys
/
{id}
Get API key by ID
curl --request GET \
  --url http://localhost:3000/v1/admin/api-keys/{id}
{
  "api_key": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "key_prefix": "<string>",
    "key_last_four": "<string>",
    "staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "scopes": [
      "<string>"
    ],
    "is_active": true,
    "expires_at": "<string>",
    "last_used_at": "<string>",
    "usage_count": 123,
    "created_at": "<string>",
    "updated_at": "<string>",
    "revoked_at": "<string>",
    "staff": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
}

Path Parameters

id
string<uuid>
required

Response

API key details

api_key
object
required