GET
/
admin
/
api-keys
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.apiKey.list()
.then(({ api_keys, count, limit, offset }) => {
  console.log(api_keys)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "api_keys": [
    {
      "id": "<string>",
      "token": "<string>",
      "redacted": "<string>",
      "title": "<string>",
      "type": "secret",
      "last_used_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "revoked_by": "<string>",
      "revoked_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

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

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

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 -.

​
q
string

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

​
id

Filter by an API key's ID.

​
title

Filter by an API key's title.

​
token

Filter by an API key's token.

​
type
enum<string>

Filter by the API key's type.

Available options:
secret,
publishable
​
created_at
object

Filter by the API key's creation date.

​
updated_at
object

Filter by the API key's update date.

​
deleted_at
object

Filter by the API key's deletion date.

​
revoked_at
object

Filter by the API key's revoke date.

​
$and
$and · object[]

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

​
$or
$or · object[]

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

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The response is of type object.