Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
/
{conversation_id}
/
crm
Get conversation CRM sidebar
curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/crm \
  --header 'api_access_token: <api-key>'
{
  "conversation_id": 100,
  "linked_lead": {
    "id": 42,
    "custom_name": "Enterprise Deal - Q3",
    "status": "open",
    "lead_value": 15000,
    "lead_currency": "USD",
    "position": 1,
    "notes": "Prospect from trade show",
    "assigned_agent": {
      "id": 1,
      "name": "Jane Smith",
      "email": "jane@example.com",
      "avatar_url": "<string>"
    },
    "company": {
      "id": 10,
      "name": "Acme Corp",
      "domain": "acme.com"
    },
    "conversation_id": 100,
    "custom_attributes": {
      "industry": "Technology",
      "annual_revenue": 500000
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "linked_funnel_card": {
    "id": 55,
    "funnel_id": 3,
    "funnel_stage_id": 7,
    "lead": {
      "id": 42,
      "custom_name": "Enterprise Deal - Q3",
      "status": "open",
      "lead_value": 15000,
      "lead_currency": "USD",
      "position": 1,
      "notes": "Prospect from trade show",
      "assigned_agent": {
        "id": 1,
        "name": "Jane Smith",
        "email": "jane@example.com",
        "avatar_url": "<string>"
      },
      "company": {
        "id": 10,
        "name": "Acme Corp",
        "domain": "acme.com"
      },
      "conversation_id": 100,
      "custom_attributes": {
        "industry": "Technology",
        "annual_revenue": 500000
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "position": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "follow_up_tasks": [
    {
      "id": 20,
      "title": "Follow up with prospect",
      "description": "Call back after proposal review.",
      "status": "pending",
      "priority": "medium",
      "due_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "taskable_type": "Lead",
      "taskable_id": 42,
      "assigned_to": {
        "id": 1,
        "name": "Jane Smith",
        "email": "jane@example.com",
        "avatar_url": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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.

Authorizations

api_access_token
string
header
required

API access token for authentication. Obtain from your Voxys Connect profile settings.

Path Parameters

account_id
integer
required

The numeric ID of the account.

conversation_id
integer
required

The ID of the conversation.

Response

CRM sidebar data.

conversation_id
integer
Example:

100

linked_lead
object
linked_funnel_card
object
follow_up_tasks
object[]