Skip to main content
GET
/
api
/
v1
/
api-keys
/
api_keys
/
List API Keys
curl --request GET \
  --url https://api.example.com/api/v1/api-keys/api_keys/ \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "store_name": "<string>",
    "organization_role": {
      "id": 123,
      "user": {
        "id": 123,
        "best_identifier": "<string>"
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "is_active": true
  }
]

Authorizations

​
X-API-Key
string
header
required

API key in format: sk_*

Response

200 - application/json
​
id
integer
required
read-only
​
name
string
required

A human-readable name for this API key

Maximum string length: 255
​
store_name
string
required
read-only
​
organization_role
object
required
​
created_at
string<date-time>
required
read-only
​
last_used_at
string<date-time> | null
​
expires_at
string<date-time> | null
​
is_active
boolean