> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useanima.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Get api keysscopes



## OpenAPI

````yaml /openapi.json get /api-keys/scopes
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /api-keys/scopes:
    get:
      operationId: apiKeys.listScopes
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  wildcard:
                    const: '*'
                    description: >-
                      The wildcard scope identifier ('*') that grants full
                      access
                  scopes:
                    type: array
                    items:
                      type: object
                      properties:
                        scope:
                          enum:
                            - '*'
                            - email:read
                            - email:send
                            - phone:read
                            - phone:sms
                            - phone:voice
                            - phone:provision
                            - messages:read
                            - messages:send
                            - messages:search
                            - voice:read
                            - vault:read
                            - vault:write
                            - vault:share
                            - vault:oauth
                            - identity:read
                            - identity:write
                            - agents:read
                            - agents:write
                            - inbox:read
                            - inbox:write
                            - domains:read
                            - domains:write
                            - addresses:read
                            - addresses:write
                            - pods:read
                            - pods:write
                            - webhooks:read
                            - webhooks:write
                            - billing:read
                            - audit:read
                          type: string
                          description: The scope identifier (e.g. 'email:send')
                        description:
                          type: string
                          description: Human-readable description of what this scope grants
                        group:
                          type: string
                          description: UI grouping name (e.g. 'Email', 'Phone', 'Cards')
                      required:
                        - scope
                        - description
                        - group
                      description: Metadata for a single scope in the catalogue
                    description: >-
                      All scopes a customer can grant to an API key, ordered by
                      group
                required:
                  - wildcard
                  - scopes
                description: Full catalogue of scopes available for API keys
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````