API references
Search documentation... ⌘K
API references
Open merchant dashboard
Merchant API
All our references

List all API keys

Retrieve a list of all API keys associated with your merchant account. This endpoint returns an array of key objects containing details about each key, including:

  • Key name and ID
  • Creation time
  • Current status (enabled or disabled)

See generate-key or find-key for the complete list of response attributes.

Common use cases for this endpoint:

  • Auditing active API keys
  • Identifying unused or outdated keys that should be rotated

Note: For security reasons, this endpoint only returns metadata about your keys - it never returns the actual key values. Make sure to securely store your key values when they are first generated, as they cannot be retrieved later.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/list-keys HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{}
Returns: array
New to Reservepay? Read our guide on how to call endpoints to get started.
Response attributes
Attribute Description
key_id
string

The ID of the key. This can be used as an argument to find-key.
key
string

The secret key. It will only be shown once as a response to generate-key. Subsequent calls using find-key will display MASKED instead.
name
string

The name of the key that you provided when creating it.
revoked
boolean

Whether the key is revoked. If it is revoked, it cannot be used to make API requests.
created_at
number

The timestamp of the key creation as a Unix timestamp.
Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/list-keys" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{}'
Learn how to run these code samples in your terminal by reading our guide.