Retrieve an API key

GET

/api-keys/{id}

Fetches a single API key by its unique identifier, returning its full details including status, usage timestamps, and rotation history. The secret key is never returned — only the public key is exposed, except on sandbox servers where a sandbox_meta.secret_key_plain field is additionally included for keys that still have a persisted plaintext secret, to ease local testing. Use this endpoint to inspect key state (e.g. to check whether it has been revoked, when it was last used, or when the secret was last rotated). Only a key owned by the caller's identity or entity is returned; keys belonging to others resolve as not found.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

API key found and returned successfully.

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api-keys/01J5X8PMKW3RNVBQE2D7F9GHAT' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Live key retrieved outside of a sandbox environment

{
    "message": "API key retrieved successfully",
    "status": "success",
    "data": {
        "id": "01J5X8PMKW3RNVBQE2D7F9GHAT",
        "name": "Production Server Key",
        "environment": "live",
        "identity_id": "01J5X8PMKW3RNVBQE2D7F9GHBT",
        "public_key": "pk_live_8f2a1c7d3e9b4f5a",
        "expires_at": null,
        "status": "active",
        "acl": {
            "can_view_api_key": true,
            "can_list_api_keys": true
        },
        "config": {
            "allowed_ip": {
                "203.0.113.10": true
            }
        },
        "last_reset": 1754478720000,
        "last_used_at": 1754565120000,
        "revoked_at": null,
        "created_by": "01J5X8PMKW3RNVBQE2D7F9GHBT",
        "revoked_by": null,
        "created": 1754478720000,
        "updated": 1754565120000
    }
}

Modified at 2026-09-30 00:29:30

Update an API key

Revoke an API key