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

# Get a conversation's stage



## OpenAPI

````yaml GET /v1/fetch-conversation-stage/{company_id}/{conversation_id}
openapi: 3.0.3
info:
  title: SalesCaptain API Documentation Service
  description: >
    API Documentation Service for SalesCaptain platform.

    This service provides endpoints for managing and retrieving company
    information for API documentation purposes.
  version: 0.1.0
  contact:
    name: SalesCaptain API Team
    email: support@salescaptain.com
  license:
    name: Proprietary
    url: https://salescaptain.com/license
servers:
  - url: https://api.salescaptain.com
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Health
    description: Service health and status endpoints
  - name: Companies
    description: Company management and retrieval operations
  - name: Accounts
    description: Account management and retrieval operations
  - name: Conversation Profiles
    description: Conversation profile management for communication channels
  - name: Conversations
    description: Conversation management and retrieval operations
  - name: Contacts
    description: Contact management and retrieval operations
  - name: Tags
    description: Tag listing, creation, deletion, and contact assignment operations
  - name: Custom Fields
    description: Custom field definition management
  - name: Templates
    description: SMS template retrieval operations
  - name: Analytics
    description: Call analytics and reporting operations
  - name: Stages
    description: >
      Conversation stages (inbox folders). List the stages, read a
      conversation's stage and move a conversation

      to another stage. Stage moves made in the app or through the API fire the
      `conversation.stage_change` webhook.
  - name: Webhooks
    description: >
      **Webhook Subscriptions** send an HTTP request to your URL when an event
      happens in SalesCaptain.

      Subscriptions are created in the SalesCaptain app: pick the events you
      want, your URL and the HTTP

      method (default `POST`). Each request body is the event payload as JSON,
      with the

      event name in `action`.


      | Event | When it fires | Payload schema |

      |---|---|---|

      | `contact.create` | A contact is created | `WebhookContactEvent` |

      | `contact.update` | A contact is updated | `WebhookContactEvent` |

      | `contact.delete` | A contact is deleted | `WebhookContactEvent` |

      | `message.sms` | An SMS is sent or received | `WebhookMessageEvent` |

      | `message.email` | An email is sent or received | `WebhookMessageEvent` |

      | `message.webchat` | A web chat message is sent or received |
      `WebhookMessageEvent` |

      | `message.fb` | A Facebook message is sent or received |
      `WebhookMessageEvent` |

      | `message.ig` | An Instagram message is sent or received |
      `WebhookMessageEvent` |

      | `campaign.opt_out` | A contact opts out of a campaign message |
      `WebhookWorkflowEvent` |

      | `campaign.replied` | A contact replies to a campaign message |
      `WebhookWorkflowEvent` |

      | `automation.opt_out` | A contact opts out of an automation message |
      `WebhookWorkflowEvent` |

      | `automation.replied` | A contact replies to an automation message |
      `WebhookWorkflowEvent` |

      | `conversation.stage_change` | A conversation is moved to a different
      stage | `WebhookStageChangeEvent` |


      Example `message.sms` request body:


      ```json

      {
        "action": "message.sms",
        "direction": "inbound",
        "timestamp": "7/14/2026, 8:43 AM",
        "channel": "sms",
        "body": "Yes, Friday works for me",
        "media": null,
        "from": "+14155551234",
        "to": "+14155559876"
      }

      ```


      Respond with any 2xx status. Failed deliveries are not retried.
externalDocs:
  description: SalesCaptain API Documentation
  url: https://docs.salescaptain.com
paths:
  /v1/fetch-conversation-stage/{company_id}/{conversation_id}:
    get:
      tags:
        - Stages
      summary: Get a conversation's current stage
      operationId: fetchConversationStage
      parameters:
        - name: company_id
          in: path
          required: true
          description: Unique identifier for the company
          schema:
            type: string
            format: uuid
            example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        - name: conversation_id
          in: path
          required: true
          description: Unique identifier for the conversation
          schema:
            type: string
            format: uuid
            example: b2c3d4e5-f6a7-8901-bcde-f12345678901
      responses:
        '200':
          description: Conversation stage fetched successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Conversation stage fetched successfully!
                  data:
                    type: object
                    properties:
                      conversation_id:
                        type: string
                        format: uuid
                      contact_id:
                        type: string
                        format: uuid
                      conversation_profile_id:
                        type: string
                        format: uuid
                        nullable: true
                      stage:
                        $ref: '#/components/schemas/Stage'
              example:
                message: Conversation stage fetched successfully!
                data:
                  conversation_id: b2c3d4e5-f6a7-8901-bcde-f12345678901
                  contact_id: e5f6a7b8-c9d0-1234-ef12-345678901234
                  conversation_profile_id: c3d4e5f6-a7b8-9012-cdef-123456789012
                  stage:
                    stage_id: e5f6a7b8-0008-4a5b-8c9d-1234567890ab
                    name: Job Scheduled
                    emoji: 📅
                    order: 1
                    is_default: false
                    is_spam: false
                    is_lead: true
                    is_lost: false
        '400':
          description: Missing or invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          description: Conversation not found for this company
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: failure
                error: Conversation not found
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    Stage:
      type: object
      description: A conversation stage (inbox folder)
      properties:
        stage_id:
          type: string
          format: uuid
        name:
          type: string
          example: Job Scheduled
        emoji:
          type: string
          nullable: true
        order:
          type: integer
          nullable: true
          description: Display order in the inbox
        is_default:
          type: boolean
          description: true for the default "General" stage
        is_spam:
          type: boolean
        is_lead:
          type: boolean
        is_lost:
          type: boolean
    Error:
      type: object
      description: Error response object
      properties:
        error:
          type: string
          description: Error message
          example: Invalid request parameters
        code:
          type: string
          description: Error code for programmatic handling
          example: INVALID_PARAMS
        timestamp:
          type: string
          format: date-time
          description: Timestamp when the error occurred
          example: '2023-12-01T10:30:00Z'
        path:
          type: string
          description: API endpoint path where the error occurred
          example: /v1/fetch-companies
      required:
        - error
  responses:
    UnauthorizedError:
      description: Authentication token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized access
            code: UNAUTHORIZED
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
    ForbiddenError:
      description: Access forbidden - valid token but insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Forbidden access
            code: FORBIDDEN
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
    RateLimitError:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many requests, please try again later
            code: RATE_LIMIT_EXCEEDED
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
      headers:
        X-RateLimit-Limit:
          description: Request limit per time window
          schema:
            type: integer
            example: 30
        X-RateLimit-Remaining:
          description: Remaining requests in current window
          schema:
            type: integer
            example: 0
        X-RateLimit-Reset:
          description: Time when the rate limit resets
          schema:
            type: integer
            example: 1701425400
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Problem encountered while fetching companies!
            code: INTERNAL_ERROR
            timestamp: '2023-12-01T10:30:00Z'
            path: /v1/fetch-companies
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Authentication token required for accessing protected endpoints.

        The token should be obtained from the main SalesCaptain authentication
        service.

````

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