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

# Get deal stage mappings

> Returns the deal stage mappings configured for the company



## OpenAPI

````yaml /en/openapi.json get /v1/hubspot/deal-stage-mappings
openapi: 3.0.0
info:
  title: Nuvia API - Company
  description: API documentation for companies
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensagens
  - name: contacts
    x-group: Contatos
  - name: campaigns
    x-group: Campanhas
  - name: tables
    x-group: Tabelas e Listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversas
  - name: inboxes
    x-group: Caixas de Entrada
  - name: knowledge
    x-group: Base de Conhecimento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscrições em Campanha
  - name: custom-fields
    x-group: Campos Customizados
  - name: resources
    x-group: Arquivos e Anexos
  - name: hubspot
    x-group: HubSpot
paths:
  /v1/hubspot/deal-stage-mappings:
    get:
      tags:
        - hubspot
      summary: Get deal stage mappings
      description: Returns the deal stage mappings configured for the company
      operationId: HubSpotController_getDealStageMappings
      parameters: []
      responses:
        '200':
          description: Mappings returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDealStageMappingsResponseDto'
        '401':
          description: Invalid or expired token
        '403':
          description: You do not have permission to access this resource
      security:
        - JWT-auth: []
components:
  schemas:
    GetDealStageMappingsResponseDto:
      type: object
      properties:
        deal_stage_mappings:
          description: List of configured mappings
          type: array
          items:
            $ref: '#/components/schemas/DealStageMappingDto'
      required:
        - deal_stage_mappings
    DealStageMappingDto:
      type: object
      properties:
        pipeline_id:
          type: string
          description: Pipeline ID in HubSpot
          example: default
        deal_stage_id:
          type: string
          description: Deal stage ID in HubSpot
          example: appointmentscheduled
        agent_step_id:
          type: string
          description: Agent step ID in the system
          example: 507f1f77bcf86cd799439011
        object_type:
          type: string
          description: HubSpot object type synced by this mapping (contact, lead, or deal)
          example: deal
          enum:
            - contact
            - lead
            - deal
        create_deal:
          type: boolean
          description: If true, automatically creates a deal when this step is reached
          example: false
        create_contact:
          type: boolean
          description: >-
            If true, creates/links a contact in HubSpot when this step is
            reached
          example: false
        create_lead:
          type: boolean
          description: If true, automatically creates a lead when this step is reached
          example: false
        lead_label:
          type: string
          description: hs_lead_label value applied to the lead at this step
          example: WARM
        inbound_enabled:
          type: boolean
          description: >-
            Two-way per step: syncs deal_stage changes from HubSpot to the Nuvia
            step
          example: false
      required:
        - pipeline_id
        - deal_stage_id
        - agent_step_id
        - create_deal
        - create_contact
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT authentication token

````

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