GET /v1/api_keys

The API Key object

A detailed look at the API Key object and its attributes.

An API key provides programmatic access to the platform as an alternative to JWT tokens. Keys are prefixed with sk_live_ or sk_test_ depending on the environment.

The raw key is only returned once at creation time. The platform stores a SHA-256 hash of the key for authentication — the raw key cannot be retrieved after creation.

The API Key object

object string REQUIRED

data array of object REQUIRED

has_more boolean REQUIRED

url string REQUIRED

request_id string REQUIRED

Response

{
  "object": "example_object",
  "data": [
    {
      "id": "example_id",
      "ownerId": "example_ownerId",
      "resellerStoreId": "example_resellerStoreId",
      "prefix": "example_prefix",
      "name": "example_name",
      "lastUsedAt": "example_lastUsedAt",
      "createdAt": "example_createdAt",
      "revokedAt": "example_revokedAt"
    }
  ],
  "has_more": true,
  "url": "example_url",
  "request_id": "example_request_id"
}

Response

{
  "object": "example_object",
  "data": [
    {
      "id": "example_id",
      "ownerId": "example_ownerId",
      "resellerStoreId": "example_resellerStoreId",
      "prefix": "example_prefix",
      "name": "example_name",
      "lastUsedAt": "example_lastUsedAt",
      "createdAt": "example_createdAt",
      "revokedAt": "example_revokedAt"
    }
  ],
  "has_more": true,
  "url": "example_url",
  "request_id": "example_request_id"
}