Skip to main content
GET
/
api
/
v3
/
admin
/
api_keys
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: keys } = await client.apiKeys.list()
{
  "data": [
    {
      "id": "key_UkLWZg9DAJ",
      "name": "Storefront key",
      "key_type": "publishable",
      "token_prefix": null,
      "scopes": [],
      "created_at": "2026-06-01T13:00:35.563Z",
      "updated_at": "2026-06-01T13:00:35.563Z",
      "revoked_at": null,
      "last_used_at": null,
      "plaintext_token": "pk_X5qdCiAFfkyM8JRzA1nc8d6a",
      "created_by_email": null
    },
    {
      "id": "key_gbHJdmfrXB",
      "name": "Backend integration",
      "key_type": "secret",
      "token_prefix": "sk_j5N5Gq53H",
      "scopes": [
        "write_all"
      ],
      "created_at": "2026-06-01T13:00:35.564Z",
      "updated_at": "2026-06-01T13:00:35.564Z",
      "revoked_at": null,
      "last_used_at": null,
      "plaintext_token": null,
      "created_by_email": null
    },
    {
      "id": "key_EfhxLZ9ck8",
      "name": "sequi",
      "key_type": "secret",
      "token_prefix": "sk_52p3ctf42",
      "scopes": [
        "write_all"
      ],
      "created_at": "2026-06-01T13:00:35.565Z",
      "updated_at": "2026-06-01T13:00:35.565Z",
      "revoked_at": null,
      "last_used_at": null,
      "plaintext_token": null,
      "created_by_email": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 3,
    "pages": 1,
    "from": 1,
    "to": 3,
    "in": 3,
    "previous": null,
    "next": null
  }
}

Authorizations

​
x-spree-api-key
string
header
required

Secret API key for admin access

​
Authorization
string
header
required

JWT token for admin user authentication

Headers

​
x-spree-api-key
string
required
​
Authorization
string
required

Response

200 - application/json

API keys found