API Keys

List API keys

Returns paginated list of API keys.

get/v0.1/merchants/{merchant_code}/api-keys

Path parameters

merchant_codestring required
Example:MC0X0ABC

Unique identifier of the merchant account.

Query parameters

offsetinteger

Offset of the first key to return.

limitinteger
Example:10

Maximum number of keys to return.

Response

List of API keys.

total_countinteger required

Total number of API keys.

Example response

{
  "items": [
    {
      "created_at": "2023-03-24T10:10:10Z",
      "id": "sup_pk_1tpmgizNLHMkx1DdKd2hdzorZAaf6AcZ9",
      "name": "",
      "preview": "Aaf6AcZ9",
      "scopes": [],
      "type": "public",
      "updated_at": "2023-03-24T10:10:10Z"
    },
    {
      "created_at": "2023-03-25T09:10:10Z",
      "id": "sup_pk_0D1FIpM6xqueY3L4Y994nseK0xMfOjPAU",
      "name": "Test Key",
      "preview": "TGhqew1b",
      "scopes": [
        "transactions.history",
        "user.app-settings",
        "user.profile_readonly",
        "user.profile",
        "user.subaccounts",
        "user.payout-settings",
        "products",
        "payments",
        "payment_instruments",
        "readers.read",
        "readers.write"
      ],
      "type": "secret",
      "updated_at": "2023-03-25T09:10:10Z"
    }
  ],
  "total_count": 2
}

Changes