API Key - List

GET /v2/api-keys/list

Retrieve a list of API Keys.

cURL

curl
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/api-keys/list \
  --header 'api-key: <api-key>'

Example Response (200)

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"
  }
]

Authorizations

  • Header: api-key (string) — required Admin API keys allow performing privileged actions such as creating a merchant account and Connector 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.

Response (200 — application/json)

List of API Keys retrieved successfully. Each item contains:

key_id

  • Type: string

  • Required: yes

  • Description: The identifier for the API Key.

  • Maximum length: 64

  • Example: "5hEEqkgJUyuxgSKGArHA4mWSnX"

merchant_id

  • Type: string

  • Required: yes

  • Description: The identifier for the Merchant Account.

  • Maximum length: 64

  • Example: "y3oqhf46pyzuxjbcn2giaqnb44"

name

  • Type: string

  • Required: yes

  • Description: The unique name for the API Key to help you identify it.

  • Maximum length: 64

  • Example: "Sandbox integration key"

prefix

  • Type: string

  • Required: yes

  • Description: The first few characters of the plaintext API Key to help you identify it.

  • Maximum length: 64

created

  • Type: string

  • Required: yes

  • Description: The time at which the API Key was created.

  • Example: "2022-09-10T10:11:12Z"

expiration

  • Type: enum | string

  • Required: yes

  • Description: The expiration of the API Key.

  • Available options: never

description

  • Type: string | null

  • Description: 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"

PreviousMerchant Account - KV StatusNextPayouts - List