List API keys

GET

/api-keys

Returns a cursor-paginated list of API keys belonging to the authenticated entity, ordered from newest to oldest. Optionally scope results to a single identity with identity_id, and further narrow with the optional environment and status filters. Fetch the next page by passing the cursor value from the previous response's meta.pagination.cursor field. The secret_key is never included in list results.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Query Params

Responses

🟢200

application/json

API keys returned successfully. If meta.pagination.has_more is true, pass meta.pagination.cursor as the cursor query parameter to retrieve the next page.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api-keys?identity_id=01J5X8PMKW3RNVBQE2D7F9GHBT&cursor=01J5X8PMKW3RNVBQE2D7F9GHAT&limit=20&environment=live&status=active' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Page with results and more available

{
    "message": "API keys 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": {
                "payout-intents.create": true,
                "payout-intents.list": true
            },
            "config": {
                "allowed_ip": {
                    "203.0.113.10": true
                }
            },
            "last_reset": 1754478720000,
            "last_used_at": 1754565120000,
            "revoked_at": null,
            "created_by": "01J5X8PMKW3RNVBQE2D7F9GHBT",
            "created": 1754478720000,
            "updated": 1754565120000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01J5X8PMKW3RNVBQE2D7F9GHAT",
            "has_more": true
        }
    }
}

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

Create an API key

Update an API key