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

> Read the HubSpot AI user, handoff assignment, reply-all, close stage, and handoff comment settings.



## OpenAPI

````yaml get /integrations/hubspot/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/hubspot/settings:
    get:
      summary: Get HubSpot integration settings
      description: >-
        The HubSpot integration settings: the AI's seat user, who handed-off
        conversations go to, reply-all, the close stage and the handoff comment.
        Credentials are never returned. `connected: false` (with `settings:
        null`) when HubSpot is not connected.
      operationId: getHubspotIntegrationSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubspotPublicSettingsResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    HubspotPublicSettingsResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/HubspotPublicSettingsResponseDto'
      type: object
      properties:
        connected:
          type: boolean
          description: false = HubSpot is not connected; settings is null
        settings:
          anyOf:
            - $ref: '#/components/schemas/HubspotPublicSettingsDto'
            - type: 'null'
      required:
        - connected
        - settings
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    HubspotPublicSettingsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/HubspotPublicSettingsDto'
      type: object
      properties:
        default_user_id:
          type: string
          description: >-
            HubSpot user id the AI acts as (its seat); conversations it owns are
            assigned to this user
        handoff_assignment_type:
          type: string
          enum:
            - unassigned
            - assign_to_user
            - leave_unchanged
          description: >-
            After handoff: unassigned = clear the owner, assign_to_user = assign
            to handoff_user_id, leave_unchanged = keep the current owner
        handoff_user_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            HubSpot user id handed-off conversations go to when
            handoff_assignment_type is assign_to_user
        ai_reply_to_all_enabled:
          type: boolean
          description: >-
            true = AI email replies go to every recipient on the thread
            (reply-all), not just the sender
        close_ticket_stage_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            HubSpot ticket pipeline stage id used when a session is closed; null
            = the pipeline default closed stage
        post_handoff_note:
          type: boolean
          description: >-
            true = a handoff posts a summary comment on the HubSpot
            conversation/ticket
      required:
        - default_user_id
        - handoff_assignment_type
        - handoff_user_id
        - ai_reply_to_all_enabled
        - close_ticket_stage_id
        - post_handoff_note
      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.