API Key - List

Retrieve a list of API keys for a merchant account.

Request

GET /api_keys/{merchant_id}/list

Headers:

api-key (string, required) — Admin API keys allow privileged actions such as creating a merchant account and Merchant Connector account.

cURL

curl

curl --request GET \
  --url https://sandbox.hyperswitch.io/api_keys/{merchant_id}/list \
  --header 'api-key: <api-key>'

Path Parameters

merchant_id (string, required) The unique identifier for the merchant account.

Query Parameters

limit (integer | null) The maximum number of API Keys to include in the response.
skip (integer | null) The number of API Keys to skip when retrieving the list of API keys.

Successful Response

200 — application/json List of API Keys retrieved successfully

Example response:

response (application/json)

[
  {
    "key_id": "5hEEqkgJUyuxgSKGArHA4mWSnX",
    "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
    "name": "Sandbox integration key",
    "prefix": "<string>",
    "created": "2022-09-10T10:11:12Z",
    "expiration": "never",
    "description": "Key used by our developers to integrate with the sandbox environment"
  }
]

Response Fields

key_id (string, required) The identifier for the API Key. Maximum length: 64 Example: "5hEEqkgJUyuxgSKGArHA4mWSnX"
merchant_id (string, required) The identifier for the Merchant Account. Maximum length: 64 Example: "y3oqhf46pyzuxjbcn2giaqnb44"
name (string, required) The unique name for the API Key to help you identify it. Maximum length: 64 Example: "Sandbox integration key"
prefix (string, required) The first few characters of the plaintext API Key to help you identify it. Maximum length: 64
created (string, required) The time at which the API Key was created. Example: "2022-09-10T10:11:12Z"
expiration (enum | string, required) Available options: never
description (string | null) The description to provide more context about the API Key. Maximum length: 256 Example: "Key used by our developers to integrate with the sandbox environment"

Good afternoon