Show an API key - Spree Commerce documentation

GET

api

admin

api_keys

{id}

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

const key = await client.apiKeys.get('key_xxx')

{
  "id": "key_UkLWZg9DAJ",
  "name": "Storefront key",
  "key_type": "publishable",
  "token_prefix": null,
  "scopes": [],
  "created_at": "2026-06-01T13:00:36.433Z",
  "updated_at": "2026-06-01T13:00:36.433Z",
  "revoked_at": null,
  "last_used_at": null,
  "plaintext_token": "pk_mJJoncofqeMtfc2vYy6gL1K5",
  "created_by_email": 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

Path Parameters

string

required

Response

200 - application/json

API key found

Create an API key

Delete an API key

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

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

const key = await client.apiKeys.get('key_xxx')

{
  "id": "key_UkLWZg9DAJ",
  "name": "Storefront key",
  "key_type": "publishable",
  "token_prefix": null,
  "scopes": [],
  "created_at": "2026-06-01T13:00:36.433Z",
  "updated_at": "2026-06-01T13:00:36.433Z",
  "revoked_at": null,
  "last_used_at": null,
  "plaintext_token": "pk_mJJoncofqeMtfc2vYy6gL1K5",
  "created_by_email": null
}