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

# List API Key Scope Presets

> Returns the named scope bundles you can put in `scopes` when you create a key, and the scopes each one expands to. No authentication needed.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/api-keys/scope-presets
openapi: 3.0.1
info:
  title: Hamsa API
  description: >-
    The Hamsa API: voice agents and their calls, phone numbers, batch calls and
    knowledge bases; speech to text, text to speech, voices and AI content.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.tryhamsa.com
security: []
paths:
  /v1/projects/api-keys/scope-presets:
    get:
      summary: List scope presets
      description: >-
        Returns the named scope bundles you can put in `scopes` when you create
        a key, and the scopes each one expands to. No authentication needed.
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      presets:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              enum:
                                - calls_only
                                - campaigns_only
                                - transcription_only
                                - tts_only
                                - ai_content_only
                                - translate_only
                                - realtime_only
                              description: Preset name to use in `scopes`.
                            description:
                              type: string
                            scopes:
                              type: array
                              items:
                                type: string
                              description: The scopes the preset expands to.
                        example:
                          - name: calls_only
                            description: Initiate and monitor voice calls only
                            scopes:
                              - agents:read
                              - agents:call
                              - phone_numbers:read
                              - phone_numbers:update
                              - call_history:read
                              - call_history:monitor
                          - name: campaigns_only
                            description: Manage outbound call campaigns
                            scopes:
                              - agents:read
                              - outbound_calls:create
                              - outbound_calls:read
                              - outbound_calls:update
                              - outbound_calls:delete
                              - outbound_calls:launch
                              - outbound_calls:stop
                          - name: transcription_only
                            description: Submit transcription jobs only
                            scopes:
                              - transcription:create
                          - name: tts_only
                            description: Create TTS and TTS history jobs only
                            scopes:
                              - tts:create
                          - name: ai_content_only
                            description: Generate AI content from transcriptions only
                            scopes:
                              - transcription:create
                          - name: translate_only
                            description: Submit translation jobs only
                            scopes:
                              - translate:create
                          - name: realtime_only
                            description: Use live TTS/STT streams only
                            scopes:
                              - realtime:create
        '500':
          description: Server Side Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyError'
      security: []
components:
  schemas:
    ApiKeyError:
      type: object
      description: Error returned by the API key routes.
      properties:
        code:
          type: integer
          enum:
            - 5400
            - 5403
            - 5404
            - 5409
            - 5500
          description: 'Service error code: 5000 + the HTTP status.'
          example: 5409
        message:
          type: string
          description: What went wrong, in English.
          example: This API key was already revoked.
        messageKey:
          type: string
          enum:
            - PermissionDenied
            - ApiKeyNotFound
            - ApiKeyExpired
            - ApiKeyAlreadyRevoked
            - LegacyApiKeysRetired
            - DefaultApiKeyProtected
            - LastApiKeyProtected
            - SomethingWentWrong
          description: >-
            Stable error key to branch on. `SomethingWentWrong` for errors
            without their own key (read `message`).
          example: ApiKeyAlreadyRevoked
        params:
          type: object
          additionalProperties: true
          description: >-
            Details for some errors: `action` (for example `api_keys:revoke`) on
            `PermissionDenied`, `reason: "DISABLED_BY_OTHER"` and `disabledBy`
            when you try to enable your own key that someone else disabled,
            `expired` on `LastApiKeyProtected`.
          example:
            action: api_keys:revoke

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.