> ## 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 Zendesk integration settings

> Read the Zendesk ticket creation, assignment, handoff, internal-note, and recipient settings.



## OpenAPI

````yaml get /integrations/zendesk/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:
  /integrations/zendesk/settings:
    get:
      summary: Get Zendesk integration settings
      description: >-
        The Zendesk integration settings: ticket creation and assignment
        defaults, handoff behaviour, internal-note handling and recipient
        editing. Credentials are never returned. `connected: false` (with
        `settings: null`) when Zendesk is not connected.
      operationId: getZendeskIntegrationSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZendeskPublicSettingsResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    ZendeskPublicSettingsResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/ZendeskPublicSettingsResponseDto'
      type: object
      properties:
        connected:
          type: boolean
          description: false = Zendesk is not connected; settings is null
        settings:
          anyOf:
            - $ref: '#/components/schemas/ZendeskPublicSettingsDto'
            - type: 'null'
      required:
        - connected
        - settings
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    ZendeskPublicSettingsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/ZendeskPublicSettingsDto'
      type: object
      properties:
        subdomain:
          type: string
          description: Connected Zendesk subdomain (read-only here)
        default_agent_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Zendesk user id new tickets are assigned to when no team mapping
            applies
        default_agent_group_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Zendesk group id new tickets go to when no team mapping applies;
            null = none
        create_ticket_only_on_handoff:
          type: boolean
          description: >-
            true = a ticket is created only when the session is handed off to a
            human
        skip_handoff_for_web:
          type: boolean
          description: true = web handoffs stay inside OpenCX and never sync to Zendesk
        skip_ticket_creation_for_web:
          type: boolean
          description: true = no Zendesk ticket is created for web sessions
        sync_automated_sender_tickets:
          type: boolean
          description: >-
            true = tickets from automated senders (noreply@…) still get a
            session; the AI never replies to them
        create_tickets_for_email_sessions:
          type: boolean
          description: >-
            true = every email session opens a Zendesk ticket up front; false =
            only on handoff
        ai_reads_private_notes:
          type: boolean
          description: true = Zendesk internal notes are given to the AI as private context
        post_handoff_note:
          type: boolean
          description: >-
            true = a handoff posts a "Handoff Summary" internal note on the
            ticket
        email_recipient_sync_enabled:
          type: boolean
          description: >-
            true = agents can edit To/Cc recipients in OpenCX and the edits sync
            to Zendesk
      required:
        - subdomain
        - default_agent_id
        - default_agent_group_id
        - create_ticket_only_on_handoff
        - skip_handoff_for_web
        - skip_ticket_creation_for_web
        - sync_automated_sender_tickets
        - create_tickets_for_email_sessions
        - ai_reads_private_notes
        - post_handoff_note
        - email_recipient_sync_enabled
      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.