Lists the partner's API keys

Request

GET {{baseURL}}/v2/partner/api-keys

This endpoint lists the API keys of the merchants managed by the partner account.

Omit merchantId to list the keys of every merchant under the partner account. Set it to list only one merchant's keys. Revoked keys do not appear.

This endpoint requires a partner API token. A merchant API token, even one belonging to a merchant managed by the partner account, is rejected with a 403 response. A token that resolves to neither a merchant nor a partner also returns a 403 response. The partner account must also have the GeneralConfigurations permission. Otherwise, the request returns a 403 response.

See Also:
To list the partner's merchants, see GET /v2/partner/merchants.
To create an API key, see POST /v2/partner/api-keys.
To revoke an API key, see DELETE /v2/partner/api-keys/{{clientId}}.

[ Request body ] [ Response body ]

Security

Bearer

Query

pageIndexinteger, (int32), [ 0 .. 100000 ]

Specifies the zero-based page index.

Valid values range from zero to 100000.

Example: 0

Default:0

Example:pageIndex=0

pageSizeinteger, (int32), [ 1 .. 100 ]

Specifies the number of items per page.

Valid values range from 1 to 100.

Example: 20

Default:20

Example:pageSize=20

merchantIdstring, (UUID)

Filters to the API keys of this merchant.

This value must not be an empty GUID. Omit to list the keys of every merchant under the partner account.

Example: 8db2ff47-b143-4adb-ab58-a4a017504db2

Example:merchantId=8db2ff47-b143-4adb-ab58-a4a017504db2

sortBystring

Specifies the field to sort by.

Valid values are:

Value	Description
apiKeyName	Sorts by the key's display name.
createdOn	Sorts by when the key was created. This is the default.
lastUsedOn	Sorts by when the key last obtained or refreshed an API token. A key that never obtained a token sorts as older than any key that has.

Example: createdOn

Default:"createdOn"

Example:sortBy=createdOn

sortOrderstring, <= 4 characters

Specifies the sort order.

Valid values are:

Value	Description
asc	Sorts from the lowest value to the highest, or from the oldest timestamp to the most recent.
desc	Sorts from the highest value to the lowest, or from the most recent timestamp to the oldest. This is the default.

Example: desc

Default:"desc"

Example:sortOrder=desc

// Language is not supported.

Responses

Bodyapplication/json

itemsArray of objects

Indicates the API keys on the current page.

It is empty when the requested page is beyond the data, or no key matches the filters.

pageInfoobject

Indicates an object describing the pagination status.

If additional pages to review are needed, repeat the exact same search but include a new pageIndex value. Typically, this will increment the current pageIndex by one. However, any valid value may be used. Value restrictions include:

A value less than zero is not permitted.
Values equal to or greater than totalPages end successfully but will not return any items.

Response

The first page of API keys across every merchant under the partner account, newest first.

{
  "items": [
    {
      "clientId": "97e7c13c-059c-4734-b017-2a20847a79d0",
      "merchantId": "886e77d0-e86f-4710-92f6-e2b84b29bd9e",
      "apiKeyName": "Production API Key",
      "createdOn": "2026-06-24T19:27:05.021Z",
      "lastUsedOn": "2026-07-01T08:15:30.526Z"
    },
    {
      "clientId": "7f191870-7de7-495a-9037-fabeefbdd089",
      "merchantId": "9040dc53-46e3-4816-b3b3-c83d885c2b07",
      "apiKeyName": "Staging API Key",
      "createdOn": "2026-05-10T10:00:00.437Z",
      "lastUsedOn": null
    }
  ],
  "pageInfo": {
    "pageIndex": 0,
    "pageSize": 20,
    "totalItems": 2,
    "totalPages": 1,
    "hasMore": false
  }
}