List available API key scopes

GET https://app.speybooks.com/api/v1/api-keys/scopes

Returns the complete scope catalogue including wildcard, global, and per-resource scopes. Use this to populate scope selection UI or validate scope strings before creating a key.

Response

200 Returns all valid scopes grouped by category (wildcard, global, per-resource).

Show response fields

categories object

Show child attributes

wildcard object

Show child attributes

description string

scope string

scopes array<string>

Request GET /v1/api-keys/scopes curl

curl https://api.speybooks.com/v1/api-keys/scopes \
  -H "Authorization: Bearer sk_test_..."

Response 200

{
  "success": true,
  "data": {
    "scopes": [
      "*",
      "read",
      "write",
      "invoices",
      "invoices:read",
      "invoices:write"
    ],
    "categories": {
      "wildcard": {
        "scope": "*",
        "description": "Full access to all resources"
      }
    }
  }
}