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

> Retrieve your CSAT settings — per-channel toggles plus the custom feedback-page and request-email template overrides.

# Get CSAT settings



## OpenAPI

````yaml get /csat/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: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /csat/settings:
    get:
      summary: Get CSAT settings
      description: >-
        Retrieve the CSAT settings for your organization: per-channel toggles
        plus the custom feedback-page and request-email template overrides
        (web_template_html, email_template_html, email_template_subject). A null
        template field means the default OpenCX design is used.
      operationId: getCsatSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CsatSettingsResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    CsatSettingsResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/CsatSettingsResponseDto'
      type: object
      properties:
        organization_id:
          type: string
          description: The ID of the organization
        web_enabled:
          description: Whether CSAT collection is enabled for web channel
          type: boolean
        email_enabled:
          description: Whether CSAT collection is enabled for email channel
          type: boolean
        phone_enabled:
          description: Whether CSAT collection is enabled for phone channel
          type: boolean
        whatsapp_enabled:
          description: Whether CSAT collection is enabled for WhatsApp channel
          type: boolean
        sms_enabled:
          description: Whether CSAT collection is enabled for SMS channel
          type: boolean
        slack_enabled:
          description: Whether CSAT collection is enabled for Slack channel
          type: boolean
        api_enabled:
          description: Whether CSAT collection is enabled for API channel
          type: boolean
        web_voice_enabled:
          description: Whether CSAT collection is enabled for web voice channel
          type: boolean
        instagram_enabled:
          description: Whether CSAT collection is enabled for Instagram channel
          type: boolean
        messenger_enabled:
          description: Whether CSAT collection is enabled for Facebook Messenger channel
          type: boolean
        custom_message:
          anyOf:
            - type: string
            - type: 'null'
          description: Custom message to display with CSAT request
        auto_send_on_close:
          description: Whether to automatically send CSAT after session closes
          type: boolean
        send_delay_minutes:
          description: Delay in minutes before sending CSAT after session closes
          type: number
        web_template_html:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Full-HTML template for the public CSAT feedback page (null = default
            page)
        email_template_html:
          anyOf:
            - type: string
            - type: 'null'
          description: Full-HTML template for the CSAT request email (null = default email)
        email_template_subject:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Subject line for the custom CSAT request email (null = default
            subject)
        created_at:
          description: When the settings were created
          type: string
          format: date-time
        updated_at:
          description: When the settings were last updated
          type: string
          format: date-time
      required:
        - organization_id
        - web_enabled
        - email_enabled
        - phone_enabled
        - whatsapp_enabled
        - sms_enabled
        - slack_enabled
        - api_enabled
        - web_voice_enabled
        - instagram_enabled
        - messenger_enabled
        - custom_message
        - auto_send_on_close
        - send_delay_minutes
        - web_template_html
        - email_template_html
        - email_template_subject
        - created_at
        - updated_at
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````