Create an API key

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

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

const key = await client.apiKeys.create({
  name: 'Backend integration',
  key_type: 'secret',
  scopes: ['read_orders', 'write_orders']
})
// `key.plaintext_token` is available only on this response.

spree api post /api_keys -d '{"name":"Backend integration","key_type":"secret","scopes":["read_orders","write_orders"]}'

{
  "id": "key_VqXmZF31wY",
  "name": "CI key",
  "key_type": "secret",
  "token_prefix": "sk_RTADPjJfn",
  "scopes": [
    "read_orders"
  ],
  "created_at": "2026-07-27T20:00:03.022Z",
  "updated_at": "2026-07-27T20:00:03.022Z",
  "revoked_at": null,
  "last_used_at": null,
  "channel_id": null,
  "plaintext_token": "sk_RTADPjJfnvUVe2ckb1F9Kmkr",
  "created_by_email": "treasa@lemke.ca"
}

{
  "error": {
    "code": "validation_error",
    "message": "Name can't be blank and Scopes can't be blank",
    "details": {
      "name": [
        "can't be blank"
      ],
      "scopes": [
        "can't be blank"
      ]
    }
  }
}