> ## 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.

# List macro variables

> List the variables a macro body can use: built-in system variables and your custom variables. Read-only; custom variables are authored in the dashboard.

Custom variables are created in **Settings → Macros → Variables** and cannot be written through the API. A name with a dot, such as `contact.full_name`, must be one of `enums`; a name without a dot refers to a custom variable and renders as empty text when no variable of that name exists.


## OpenAPI

````yaml get /macros/variables
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/variables:
    get:
      summary: List macro variables
      description: >-
        List the variables available for use in macro content: built-in `enums`
        (system variables like {{contact.full_name}}) and the organization's
        `custom` variables. Reference them in macro content with {{variable}}
        syntax. Custom variables are authored and managed in the OpenCX
        dashboard — this endpoint is read-only.
      operationId: listMacroVariables
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedReplyVariablesResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    SavedReplyVariablesResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SavedReplyVariablesResponseDto'
      type: object
      properties:
        enums:
          type: array
          items:
            $ref: '#/components/schemas/SavedReplyVariableEnum'
        custom:
          type: array
          items:
            $ref: '#/components/schemas/SavedReplyVariableDto'
      required:
        - enums
        - custom
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    SavedReplyVariableEnum:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SavedReplyVariableEnum'
      type: string
      enum:
        - agent.full_name
        - agent.first_name
        - agent.email
        - contact.full_name
        - contact.first_name
        - contact.last_name
        - contact.email
        - contact.phone
        - session.number
        - session.status
        - session.language
        - org.name
    SavedReplyVariableDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SavedReplyVariableDto'
      type: object
      properties:
        id:
          type: string
        org_id:
          type: string
        name:
          type: string
        content:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - org_id
        - name
        - content
        - created_at
        - updated_at
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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