---
title: "GET /api-keys/scopes"
method: GET
path: "/api-keys/scopes"
---

# GET /api-keys/scopes

`GET /api-keys/scopes`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/api-keys/scopes`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Response `200`

OK

- object: Full catalogue of scopes available for API keys
  - `wildcard` '*', required: The wildcard scope identifier ('*') that grants full access
  - `scopes` object[], required: All scopes a customer can grant to an API key, ordered by group
    - `scope` '*' | 'email:read' | 'email:send' | 'phone:read' | 'phone:sms' | 'phone:voice' | 'phone:provision' | 'messages:read' | 'messages:send' | 'messages:search' | 'voice:read' | 'vault:read' | 'vault:use' | 'vault:write' | 'vault:share' | 'vault:oauth' | 'vault:inject' | 'identity:read' | 'identity:write' | 'agents:read' | 'agents:write' | 'inbox:read' | 'inbox:write' | 'domains:read' | 'domains:write' | 'addresses:read' | 'addresses:write' | 'webhooks:read' | 'webhooks:write' | 'billing:read' | 'audit:read' | 'extension:connect', required: The scope identifier (e.g. 'email:send')
    - `description` string, required: Human-readable description of what this scope grants
    - `group` string, required: UI grouping name (e.g. 'Email', 'Phone', 'Cards')

---

[API](https://skmtc.dev/useanima/apis/anima-api.md) · [All operations](https://skmtc.dev/useanima/apis/anima-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useanima/apis/anima-api/revisions/aaa148188980?raw)