List API Keys

GET

/admin/api-keys

Retrieve a list of API keys. The API keys can be filtered by fields such as id. The API keys can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "api_keys": [
        {
            "id": "string",
            "token": "string",
            "redacted": "string",
            "title": "string",
            "last_used_at": "2019-08-24T14:15:22Z",
            "created_by": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "revoked_by": "string",
            "revoked_at": "2019-08-24T14:15:22Z",
            "type": "secret"
        }
    ]
}

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

A search term to search the API keys' searchable properties.

optional

One of

array[string]

Filter by an API key's ID.

title

optional

One of

title

array[string]

Filter by an API key's title.

token

optional

One of

token

array[string]

Filter by an API key's token.

type

enum<string>

optional

Filter by the API key's type.

Allowed values:

secretpublishable

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["","","",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["","","",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["","","",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["","","",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["","","",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["","","",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["","","",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["","","",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["","","",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["","","",""]

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

Example:

["","","",""]

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Example:

["","","",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["","","",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["","","",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["","","",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["","","",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["","","",""]

$eq

array[string]

optional

Example:

["","","",""]

$not

array[string]

optional

Example:

["","","",""]

Responses

🟢200OK

application/json

Body

limit

number

limit

required

The maximum number of items returned in the list.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total count of items.

api_keys

array[object (ApiKeyResponse) {10}]

required

The list of API keys.

string

required

The API key's ID.

token

string

token

required

The API key's token.

redacted

string

redacted

required

The redacted form of the API key's token. This is useful when showing portion of the token. For example sk_...123.

title

string

title

required

The API key's title.

last_used_at

string <date-time>

last_used_at

required

The date the API key was last used.

created_by

string

created_by

required

The ID of the user that created the API key.

created_at

string <date-time>

created_at

required

The date the API key was created.

revoked_by

string

revoked_by

required

The ID of the user that revoked the API key.

revoked_at

string <date-time>

revoked_at

required

The date the API key was revoked.

type

enum<string>

required

The API key's type. secret API keys are used for authenticating admin users, and publishable API key are used for storefronts and similar clients to scope requests to sales channels.

Allowed values:

secretpublishable

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Create Api Key

Remove Products from Price List