List API Keys

GET

/api/ApiKeys

curl --request GET \
  --url https://example.com/api/ApiKeys \
  --header 'Authorization: Bearer <token>'

Returns API keys for a merchant. Plaintext is never included; revoked keys are excluded by default.

Authorizations

• Bearer

Parameters

Query Parameters

merchantId

string format: uuid

includeRevoked

boolean

Responses

200

OK

Media type application/json

Array<object>

object

id

string format: uuid

name

string

nullable

keyPrefix

string

nullable

signingSecretPrefix

string

nullable

webhookUrl

string

nullable

webhookEvents

Array<string>

nullable

webhookEnabled

boolean

expiresAt

string format: date-time

nullable

lastUsedAt

string format: date-time

nullable

revokedAt

string format: date-time

nullable

createdAt

string format: date-time

Example ^generated

[
  {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "keyPrefix": "example",
    "signingSecretPrefix": "example",
    "webhookUrl": "example",
    "webhookEvents": [
      "example"
    ],
    "webhookEnabled": true,
    "expiresAt": "2026-04-15T12:00:00Z",
    "lastUsedAt": "2026-04-15T12:00:00Z",
    "revokedAt": "2026-04-15T12:00:00Z",
    "createdAt": "2026-04-15T12:00:00Z"
  }
]