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

# Get conversation CRM sidebar

> Returns CRM data associated with a conversation, including linked lead, pipeline card, and follow-up tasks.



## OpenAPI

````yaml /api-reference/voxys_crm_swagger.json get /api/v1/accounts/{account_id}/conversations/{conversation_id}/crm
openapi: 3.1.0
info:
  title: Voxys Connect - CRM APIs
  description: >-
    CRM API documentation for Voxys Connect, covering Leads, Companies,
    Pipelines, Follow-up Tasks, and Conversation CRM.
  version: 1.0.0
  contact:
    email: support@voxys.ai
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://connect.voxys.ai
security:
  - userApiKey: []
tags:
  - name: Leads
    description: >-
      Manage CRM leads including creation, status changes, notes, and
      conversion.
  - name: Companies
    description: Manage companies, their contacts, timelines, and duplicate merging.
  - name: Pipelines
    description: Manage sales funnels (pipelines), their stages, and kanban cards.
  - name: Follow-up Tasks
    description: >-
      Create and manage follow-up tasks attached to leads, deals, or
      conversations.
  - name: Conversation CRM
    description: >-
      CRM panel within a conversation: link pipelines, leads, and convert to
      deal.
paths:
  /api/v1/accounts/{account_id}/conversations/{conversation_id}/crm:
    parameters:
      - $ref: '#/components/parameters/account_id'
      - name: conversation_id
        in: path
        required: true
        schema:
          type: integer
        description: The ID of the conversation.
    get:
      tags:
        - Conversation CRM
      summary: Get conversation CRM sidebar
      description: >-
        Returns CRM data associated with a conversation, including linked lead,
        pipeline card, and follow-up tasks.
      operationId: get-conversation-crm
      responses:
        '200':
          description: CRM sidebar data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/crm_sidebar'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: Conversation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
components:
  parameters:
    account_id:
      name: account_id
      in: path
      required: true
      schema:
        type: integer
      description: The numeric ID of the account.
  schemas:
    crm_sidebar:
      type: object
      properties:
        conversation_id:
          type: integer
          example: 100
        linked_lead:
          $ref: '#/components/schemas/lead'
          nullable: true
        linked_funnel_card:
          $ref: '#/components/schemas/funnel_card'
          nullable: true
        follow_up_tasks:
          type: array
          items:
            $ref: '#/components/schemas/follow_up_task'
    error_response:
      type: object
      properties:
        error:
          type: string
          example: Unauthorized
    lead:
      type: object
      properties:
        id:
          type: integer
          example: 42
        custom_name:
          type: string
          example: Enterprise Deal - Q3
        status:
          type: string
          enum:
            - open
            - won
            - lost
            - snoozed
          example: open
        lead_value:
          type: number
          format: float
          nullable: true
          example: 15000
        lead_currency:
          type: string
          nullable: true
          example: USD
        position:
          type: integer
          nullable: true
          example: 1
        notes:
          type: string
          nullable: true
          example: Prospect from trade show
        assigned_agent:
          $ref: '#/components/schemas/agent_summary'
          nullable: true
        company:
          $ref: '#/components/schemas/company_summary'
          nullable: true
        conversation_id:
          type: integer
          nullable: true
          example: 100
        custom_attributes:
          $ref: '#/components/schemas/custom_attributes'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    funnel_card:
      type: object
      properties:
        id:
          type: integer
          example: 55
        funnel_id:
          type: integer
          example: 3
        funnel_stage_id:
          type: integer
          example: 7
        lead:
          $ref: '#/components/schemas/lead'
        position:
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    follow_up_task:
      type: object
      properties:
        id:
          type: integer
          example: 20
        title:
          type: string
          example: Follow up with prospect
        description:
          type: string
          nullable: true
          example: Call back after proposal review.
        status:
          type: string
          enum:
            - pending
            - completed
            - snoozed
          example: pending
        priority:
          type: string
          enum:
            - low
            - medium
            - high
          example: medium
        due_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        taskable_type:
          type: string
          example: Lead
        taskable_id:
          type: integer
          example: 42
        assigned_to:
          $ref: '#/components/schemas/agent_summary'
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    agent_summary:
      type: object
      properties:
        id:
          type: integer
          example: 1
        name:
          type: string
          example: Jane Smith
        email:
          type: string
          format: email
          example: jane@example.com
        avatar_url:
          type: string
          format: uri
          nullable: true
    company_summary:
      type: object
      properties:
        id:
          type: integer
          example: 10
        name:
          type: string
          example: Acme Corp
        domain:
          type: string
          example: acme.com
          nullable: true
    custom_attributes:
      type: object
      description: Flexible key-value map of custom attributes defined for the account.
      additionalProperties: true
      example:
        industry: Technology
        annual_revenue: 500000
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        API access token for authentication. Obtain from your Voxys Connect
        profile settings.

````