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

# Get macro settings

> Read the macro settings: the languages macros are translated into, how many can be chosen, the supported languages, and the suggestions switch.

`translation_languages` is in the order the languages were chosen; an empty list means macro translation is off, which is the default. `suggestions_enabled` is the workspace switch for suggested macros. It is read-only in the API.


## OpenAPI

````yaml get /macros/settings
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /macros/settings:
    get:
      summary: Get macro settings
      description: >-
        The macro settings: the languages every org-wide macro is translated
        into (`translation_languages`, empty when translation is off), the most
        that can be chosen, the language codes that can be chosen, and whether
        suggested macros are on for the workspace.
      operationId: getMacroSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MacroSettingsDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    MacroSettingsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/MacroSettingsDto'
      type: object
      properties:
        translation_languages:
          type: array
          items:
            type: string
          description: >-
            Language codes (lower-case, such as `es`) every org-wide macro is
            translated into, in the order they were chosen. Empty means macro
            translation is off.
        max_translation_languages:
          type: number
          description: The most languages that can be chosen.
        supported_translation_languages:
          type: array
          items:
            type: string
          description: The language codes that can be chosen.
        suggestions_enabled:
          type: boolean
          description: >-
            Whether suggested macros are on for the workspace. When off, no
            agent sees them.
      required:
        - translation_languages
        - max_translation_languages
        - supported_translation_languages
        - suggestions_enabled
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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