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

# Read assignment, hours, reply targets, email handling, the caller signature and the support mailbox

> Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.



## OpenAPI

````yaml https://app.communicate.so/api/v1/openapi/mintlify.json get /workspaces/{workspaceId}/agents/{agentId}/support/settings
openapi: 3.1.0
info:
  title: Communicate Public REST API
  version: 0.1.5
  summary: >-
    Scoped agent chat, account credential lifecycle and workspace bootstrap
    operations.
  description: >-
    Canonical external schema for implemented REST operations. Account
    credentials and application sessions authorize the documented account and
    workspace operations separately from workspace keys. Exchange a workspace
    API-key client ID and secret for a short-lived OAuth access token, or use
    the `ck_` key directly for backward compatibility. `requestId` is optional
    but, when supplied, becomes the idempotency key for retries of the same chat
    input.
servers:
  - url: https://app.communicate.so/api/v1
    description: Canonical external base URL served through the Next.js /api/v1 rewrite.
security:
  - oauth2: []
  - bearerAuth: []
paths:
  /workspaces/{workspaceId}/agents/{agentId}/support/settings:
    get:
      tags:
        - Agents
      summary: >-
        Read assignment, hours, reply targets, email handling, the caller
        signature and the support mailbox
      description: >-
        Use an explicitly scoped user-bound account bearer credential or an
        application session. Scope grants are intersected with live membership,
        role, tenant isolation, agent access and plan limits; a credential does
        not grant an owner role. Invitation acceptance requires the verified
        recipient email.
      operationId: readAgentSupportSettings
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: >-
            Read assignment, hours, reply targets, email handling, the caller
            signature and the support mailbox
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/readAgentSupportSettingsResponse'
        '401':
          description: >-
            Missing, invalid, expired or revoked account credential or
            application session.
        '402':
          description: Plan entitlement, capacity or credits do not allow this operation.
        '403':
          description: >-
            Required account scope, live verified identity, membership or role
            permission is missing.
        '404':
          description: Workspace or addressed resource is not visible to this member.
        '409':
          description: >-
            Support handle, source URL or pending transfer conflicts with this
            operation.
        '422':
          description: Website URL or extraction source is not supported.
        '429':
          description: Agent request or website crawl rate limit exceeded.
        '500':
          description: Unexpected server failure.
        '503':
          description: Authorization service temporarily unavailable.
      security:
        - accountBearer: []
        - accountSession: []
        - localAccountSession: []
components:
  schemas:
    readAgentSupportSettingsResponse:
      type: object
      properties:
        canEdit:
          type: boolean
        settings:
          type: object
          properties:
            assignment:
              type: object
              properties:
                method:
                  type: string
                  enum:
                    - round_robin
                    - fewest_open
                    - manual
                limitPerPerson:
                  anyOf:
                    - type: integer
                      minimum: 1
                      maximum: 500
                    - type: 'null'
                onlineOnly:
                  type: boolean
              required:
                - method
                - limitPerPerson
                - onlineOnly
              additionalProperties: false
            hours:
              type: object
              properties:
                enabled:
                  type: boolean
                timezone:
                  type: string
                  minLength: 1
                  maxLength: 64
                days:
                  type: object
                  properties:
                    mon:
                      type: object
                      properties:
                        open:
                          type: boolean
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - open
                        - start
                        - end
                      additionalProperties: false
                    tue:
                      type: object
                      properties:
                        open:
                          type: boolean
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - open
                        - start
                        - end
                      additionalProperties: false
                    wed:
                      type: object
                      properties:
                        open:
                          type: boolean
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - open
                        - start
                        - end
                      additionalProperties: false
                    thu:
                      type: object
                      properties:
                        open:
                          type: boolean
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - open
                        - start
                        - end
                      additionalProperties: false
                    fri:
                      type: object
                      properties:
                        open:
                          type: boolean
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - open
                        - start
                        - end
                      additionalProperties: false
                    sat:
                      type: object
                      properties:
                        open:
                          type: boolean
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - open
                        - start
                        - end
                      additionalProperties: false
                    sun:
                      type: object
                      properties:
                        open:
                          type: boolean
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - open
                        - start
                        - end
                      additionalProperties: false
                  required:
                    - mon
                    - tue
                    - wed
                    - thu
                    - fri
                    - sat
                    - sun
                  additionalProperties: false
                outsideHoursReply:
                  type: string
                  maxLength: 1000
              required:
                - enabled
                - timezone
                - days
                - outsideHoursReply
              additionalProperties: false
            targets:
              type: object
              properties:
                firstReplyMinutes:
                  anyOf:
                    - type: integer
                      minimum: 1
                      maximum: 10080
                    - type: 'null'
                nextReplyMinutes:
                  anyOf:
                    - type: integer
                      minimum: 1
                      maximum: 10080
                    - type: 'null'
              required:
                - firstReplyMinutes
                - nextReplyMinutes
              additionalProperties: false
            email:
              type: object
              properties:
                ignoreAutoReplies:
                  type: boolean
                keepCc:
                  type: boolean
              required:
                - ignoreAutoReplies
                - keepCc
              additionalProperties: false
            automation:
              type: object
              properties:
                loopGuard:
                  type: boolean
              required:
                - loopGuard
              additionalProperties: false
          required:
            - assignment
            - hours
            - targets
            - email
          additionalProperties: false
        signature:
          type: string
        mailbox:
          type: object
          properties:
            address:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - address
          additionalProperties: false
      required:
        - canEdit
        - settings
        - signature
        - mailbox
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 client-credentials tokens bounded by the source API key scope
        ceiling.
      flows:
        clientCredentials:
          tokenUrl: https://app.communicate.so/api/v1/oauth/token
          scopes:
            agents:read: List agents in the authenticated workspace.
            chat:write: Create chat turns with an agent in the authenticated workspace.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Workspace API key token with the `ck_` prefix.
    accountBearer:
      type: http
      scheme: bearer
      bearerFormat: Account credential
      description: >-
        Opaque user-bound `ca_` account credential. Each request checks live
        account scopes, verified email, expiry, revocation and the issuer
        session. Not a workspace `ck_` key or OAuth access token.
    accountSession:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: >-
        Signed Better Auth session cookie for an HTTPS application origin.
        Credential management additionally requires verified email and fresh
        password proof on writes.
    localAccountSession:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: >-
        Signed session cookie used when the configured application auth origin
        is HTTP, such as local development.

````

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