Route Directory
This page is a simple endpoint directory. Expand any route to view the JSON response shape returned by the API.
Response shapes on this page as of May 30th, 2026.
V2 Routes
Organizations
GET /api/v2/organizations
{
"data": [
{
"organization_id": "HR_id_example_organization_id",
"name": "Acme Roofing"
}
]
}### Contacts
<details>
<summary><code>GET /api/v2/organizations/{'{'}organization_id{'}'}/contacts</code></summary>
```json
{
"data": [
{
"contact_id": "HR_id_example_contact_id",
"name": "Diana Prince",
"email": "[email protected]",
"phone_number": "513-867-5309",
"created_at": "2026-03-12T00:32:13.782565Z",
"company_id": "HR_id_example_company_id",
"custom_fields": {
"notes": "Prefers SMS"
},
"company_role": "Facilities Manager"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
POST /api/v2/organizations/{organization_id}/contacts
{
"contact_id": "HR_id_example_contact_id",
"name": "Hal Jordan",
"email": "[email protected]",
"phone_number": "+14155550199",
"created_at": "2026-05-15T15:34:12.000000Z",
"company_id": "HR_id_example_company_id",
"custom_fields": {
"notes": "Primary billing contact"
},
"company_role": "Controller"
}
GET /api/v2/organizations/{organization_id}/contacts/{contact_id}
{
"contact_id": "HR_id_example_contact_id",
"name": "Diana Prince",
"email": "[email protected]",
"phone_number": "513-867-5309",
"created_at": "2026-03-12T00:32:13.782565Z",
"company_id": "HR_id_example_company_id",
"custom_fields": {
"notes": "Prefers SMS"
},
"company_role": "Facilities Manager"
}
GET /api/v2/organizations/{organization_id}/contacts/{contact_id}/conversations
{
"data": [
{
"conversation_id": "HR_id_example_conversation_id",
"start_at": "2026-03-12T00:32:13.790998Z",
"last_activity_at": "2026-03-12T00:32:13.797290Z",
"folder": "primary",
"is_read": true,
"contact_id": "HR_id_example_contact_id"
}
],
"pagination": {
"limit": 50,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
Companies
GET /api/v2/organizations/{organization_id}/companies
{
"data": [
{
"company_id": "HR_id_example_company_id",
"name": "HyperRep Consumer Group",
"domain": "hyperrep.com",
"custom_fields": {
"notes": "Priority account"
},
"address": "123 Main St, Anytown USA",
"agent_id": "HR_id_example_agent_id",
"created_at": "2026-03-10T12:00:00Z"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
POST /api/v2/organizations/{organization_id}/companies
{
"company_id": "HR_id_example_company_id",
"name": "Ferris Aircraft",
"domain": "ferrisaircraft.com",
"custom_fields": {
"notes": "Enterprise account"
},
"address": "100 Coastline Ave, Coast City, CA",
"agent_id": "HR_id_example_agent_id",
"created_at": "2026-05-15T16:45:12.000000Z"
}
GET /api/v2/organizations/{organization_id}/companies/{company_id}
{
"company_id": "HR_id_example_company_id",
"name": "HyperRep Consumer Group",
"domain": "hyperrep.com",
"custom_fields": {
"notes": "Priority account"
},
"address": "123 Main St, Anytown USA",
"agent_id": "HR_id_example_agent_id",
"created_at": "2026-03-10T12:00:00Z"
}
Agents
GET /api/v2/organizations/{organization_id}/agents
{
"data": [
{
"agent_id": "HR_id_example_agent_id",
"name": "Kara Danvers",
"email": "[email protected]"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
GET /api/v2/organizations/{organization_id}/agents/{agent_id}
{
"agent_id": "HR_id_example_agent_id",
"name": "Kara Danvers",
"email": "[email protected]"
}
GET /api/v2/organizations/{organization_id}/agents/{agent_id}/conversations
{
"data": [
{
"conversation_id": "HR_id_example_conversation_id",
"start_at": "2026-03-12T01:28:11.008525Z",
"last_activity_at": "2026-03-12T01:28:41.829924Z",
"folder": "primary",
"is_read": true,
"contact_id": "HR_id_example_contact_id"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
GET /api/v2/organizations/{organization_id}/agents/{agent_id}/sales
{
"data": [
{
"sale_id": "HR_id_example_sale_id",
"associated_conversation_ids": [
"HR_id_example_conversation_id"
],
"company_id": "HR_id_example_company_id",
"owner_id": "HR_id_example_agent_id",
"associated_contacts": [
{
"contact_id": "HR_id_example_contact_id",
"is_primary": true
}
],
"quote_details": {
"output": {
"currency": "USD",
"total_price": "1200.00"
},
"arguments": {
"products": [
{
"quantity": 1,
"unit_price": "1200.00",
"product_name": "Legacy Seed Service"
}
]
}
},
"custom_fields": {
"notes": "Backfilled sale for new sales framework compatibility."
},
"current_status": {
"label": "Accepted",
"status": "accepted",
"changed_at": "2026-03-13T01:28:41.829924Z"
},
"status_history": [
{
"label": "Qualified",
"status": null,
"changed_at": "2026-03-12T01:28:41.829924Z"
},
{
"label": "Quoted",
"status": "quote_sent",
"changed_at": "2026-03-12T01:43:41.829924Z"
},
{
"label": "Accepted",
"status": "accepted",
"changed_at": "2026-03-13T01:28:41.829924Z"
}
],
"created_at": "2026-03-12T01:28:41.829924Z",
"last_activity_at": "2026-03-12T01:28:41.829924Z"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
GET /api/v2/organizations/{organization_id}/agents/{agent_id}/analytics
{
"conversations": {
"conversationsRespondedTo": 42,
"messagesSent": 118
},
"sales": {
"pipeline": [
{
"name": "Qualified",
"status": null,
"volume": 24,
"value": "28800.00"
},
{
"name": "Quoted",
"status": "quote_sent",
"volume": 18,
"value": "21600.00"
},
{
"name": "Accepted",
"status": "accepted",
"volume": 11,
"value": "13200.00"
}
],
"salesRate": 0.46
}
}
GET /api/v2/organizations/{organization_id}/agents/{agent_id}/analytics/conversations
{
"conversationsRespondedTo": 42,
"messagesSent": 118
}
GET /api/v2/organizations/{organization_id}/agents/{agent_id}/analytics/sales
{
"pipeline": [
{
"name": "Qualified",
"status": null,
"volume": 24,
"value": "28800.00"
},
{
"name": "Quoted",
"status": "quote_sent",
"volume": 18,
"value": "21600.00"
},
{
"name": "Accepted",
"status": "accepted",
"volume": 11,
"value": "13200.00"
}
],
"salesRate": 0.46
}
Conversations and Messages
GET /api/v2/organizations/{organization_id}/conversations
{
"data": [
{
"conversation_id": "HR_id_example_conversation_id",
"start_at": "2026-04-29T14:00:00Z",
"last_activity_at": "2026-04-29T16:00:00Z",
"folder": "inbox",
"is_read": false,
"contact_id": "HR_id_example_contact_id"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
GET /api/v2/organizations/{organization_id}/conversations/{conversation_id}
{
"conversation_id": "HR_id_example_conversation_id",
"start_at": "2026-04-29T14:00:00Z",
"last_activity_at": "2026-04-29T16:00:00Z",
"folder": "inbox",
"is_read": false,
"contact_id": "HR_id_example_contact_id"
}
GET /api/v2/organizations/{organization_id}/conversations/{conversation_id}/messages
{
"data": [
{
"message_id": "HR_id_example_message_id",
"conversation_id": "HR_id_example_conversation_id",
"agent_id": null,
"modality": "email",
"message_direction": "sent",
"is_form_request": false,
"subject": "Following up on your inquiry",
"content": "Hi Diana, just checking in on the quote we sent over last week.",
"call_transcript": null,
"form_request_body": null,
"sent_at": "2026-04-29T15:02:00Z",
"drafted_at": null,
"email_metadata": {
"email_message_id": "<[email protected]>",
"cc_emails": [],
"bcc_emails": []
},
"call_metadata": {
"duration": null
},
"tracked_links": [
{
"link_id": "HR_id_example_tracked_link_id",
"url": "https://example.com/quote",
"click_count": 3
}
]
}
],
"pagination": {
"limit": 50,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
GET /api/v2/organizations/{organization_id}/conversations/{conversation_id}/messages/{message_id}
{
"message_id": "HR_id_example_message_id",
"conversation_id": "HR_id_example_conversation_id",
"agent_id": null,
"modality": "email",
"message_direction": "sent",
"is_form_request": false,
"subject": "Following up on your inquiry",
"content": "Hi Diana, just checking in on the quote we sent over last week.",
"call_transcript": null,
"form_request_body": null,
"sent_at": "2026-04-29T15:02:00Z",
"drafted_at": null,
"email_metadata": {
"email_message_id": "<[email protected]>",
"cc_emails": [],
"bcc_emails": []
},
"call_metadata": {
"duration": null
},
"tracked_links": [
{
"link_id": "HR_id_example_tracked_link_id",
"url": "https://example.com/quote",
"click_count": 3
}
]
}
Message Drafts
GET /api/v2/organizations/{organization_id}/message-drafts
{
"data": [
{
"draft_id": "HR_id_example_message_draft_id",
"subject": "Following up on your quote",
"body_html": "<p>Hi Diana, checking in on the quote we sent yesterday.</p>",
"modality": "email",
"agent_id": "HR_id_example_agent_id",
"recipient_name": "Diana Prince",
"recipient_email": "[email protected]",
"recipient_phone_number": "513-867-5309",
"cc_emails": [],
"bcc_emails": [],
"scheduled_send_at": null,
"folder": "sales-follow-up",
"created_at": "2026-05-21T14:30:00Z"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
GET /api/v2/organizations/{organization_id}/message-drafts/{draft_id}
{
"draft_id": "HR_id_example_message_draft_id",
"subject": "Following up on your quote",
"body_html": "<p>Hi Diana, checking in on the quote we sent yesterday.</p>",
"modality": "email",
"agent_id": "HR_id_example_agent_id",
"recipient_name": "Diana Prince",
"recipient_email": "[email protected]",
"recipient_phone_number": "513-867-5309",
"cc_emails": [],
"bcc_emails": [],
"scheduled_send_at": null,
"folder": "sales-follow-up",
"created_at": "2026-05-21T14:30:00Z"
}
POST /api/v2/organizations/{organization_id}/message-drafts
{
"draft_id": "HR_id_example_message_draft_id",
"scheduled_to_send": false,
"scheduled_send_at": null,
"folder": "drafts"
}
DELETE /api/v2/organizations/{organization_id}/message-drafts/{draft_id}
204 No Content
GET /api/v2/organizations/{organization_id}/conversations/{conversation_id}/response-drafts
{
"data": [
{
"response_id": "HR_id_example_response_draft_id",
"conversation_id": "HR_id_example_conversation_id",
"body_html": "<p>Hi Diana, thanks for the follow-up. We can do Tuesday at 2pm.</p>",
"recipient_name": "Diana Prince",
"recipient_email": "[email protected]",
"recipient_phone_number": "513-867-5309",
"cc_emails": [],
"bcc_emails": [],
"scheduled_send_at": null,
"created_at": "2026-05-21T14:35:00Z"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": null,
"has_more": false
}
}
GET /api/v2/organizations/{organization_id}/conversations/{conversation_id}/response-drafts/{response_id}
{
"response_id": "HR_id_example_response_draft_id",
"conversation_id": "HR_id_example_conversation_id",
"body_html": "<p>Hi Diana, thanks for the follow-up. We can do Tuesday at 2pm.</p>",
"recipient_name": "Diana Prince",
"recipient_email": "[email protected]",
"recipient_phone_number": "513-867-5309",
"cc_emails": [],
"bcc_emails": [],
"scheduled_send_at": null,
"created_at": "2026-05-21T14:35:00Z"
}
POST /api/v2/organizations/{organization_id}/conversations/{conversation_id}/response-drafts
{
"response_id": "HR_id_example_response_draft_id",
"conversation_id": "HR_id_example_conversation_id",
"scheduled_to_send": false,
"scheduled_send_at": null
}
DELETE /api/v2/organizations/{organization_id}/conversations/{conversation_id}/response-drafts/{response_id}
204 No Content
Analytics
GET /api/v2/organizations/{organization_id}/analytics/conversations
{
"responseRateStats": {
"numConversationsRespondedTo": 14,
"numConversationsReceived": 20,
"responseRate": 0.7
},
"responseTimeStats": {
"responseTime": 3600
},
"volumeStats": {
"numMessagesReceived": 120,
"numMessagesSent": 118,
"totalConversations": 42
},
"modalityStats": {
"textMessages": 10,
"calls": 4,
"emails": 20,
"liveChats": 6,
"formRequests": 2
}
}
GET /api/v2/organizations/{organization_id}/analytics/conversations/response-rate
{
"numConversationsRespondedTo": 14,
"numConversationsReceived": 20,
"responseRate": 0.7
}
GET /api/v2/organizations/{organization_id}/analytics/conversations/response-time
{
"responseTime": 3600
}
GET /api/v2/organizations/{organization_id}/analytics/conversations/volume
{
"numMessagesReceived": 120,
"numMessagesSent": 118,
"totalConversations": 42
}
GET /api/v2/organizations/{organization_id}/analytics/conversations/modality
{
"textMessages": 10,
"calls": 4,
"emails": 20,
"liveChats": 6,
"formRequests": 2
}
GET /api/v2/organizations/{organization_id}/analytics/sales
{
"pipeline": [
{
"name": "Qualified",
"status": null,
"volume": 24,
"value": "28800.00"
},
{
"name": "Quoted",
"status": "quote_sent",
"volume": 18,
"value": "21600.00"
},
{
"name": "Accepted",
"status": "accepted",
"volume": 11,
"value": "13200.00"
}
],
"salesRate": 0.46
}
Audit Logs
GET /api/v2/organizations/{organization_id}/audit-logs
{
"data": [
{
"audit_log_id": "HR_id_example_audit_log_id",
"occurred_at": "2026-05-21T17:42:31.000000Z",
"agent_id": "HR_id_example_agent_id",
"action_type": "update",
"record": {
"type": "sale",
"id": "HR_id_example_sale_id"
},
"changes": [
{
"field": "status",
"from": "Qualified",
"to": "Accepted"
},
{
"field": "custom_fields",
"from": {},
"to": {
"notes": "Customer requested implementation call."
}
}
]
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": "HR_tok_example_next_cursor",
"has_more": true
}
}
GET /api/v2/organizations/{organization_id}/audit-logs/{audit_log_id}
{
"audit_log_id": "HR_id_example_audit_log_id",
"occurred_at": "2026-05-21T17:42:31.000000Z",
"agent_id": "HR_id_example_agent_id",
"action_type": "update",
"record": {
"type": "sale",
"id": "HR_id_example_sale_id"
},
"changes": [
{
"field": "status",
"from": "Qualified",
"to": "Accepted"
}
]
}
Sales
GET /api/v2/organizations/{organization_id}/sales
{
"data": [
{
"sale_id": "HR_id_example_sale_id",
"associated_conversation_ids": [
"HR_id_example_conversation_id"
],
"company_id": "HR_id_example_company_id",
"owner_id": "HR_id_example_agent_id",
"associated_contacts": [
{
"contact_id": "HR_id_example_contact_id",
"is_primary": true
}
],
"quote_details": {
"output": {
"currency": "USD",
"total_price": "1200.00"
},
"arguments": {
"products": [
{
"quantity": 1,
"unit_price": "1200.00",
"product_name": "Legacy Seed Service"
}
]
}
},
"custom_fields": {
"notes": "Backfilled sale for new sales framework compatibility."
},
"current_status": {
"label": "Accepted",
"status": "accepted",
"changed_at": "2026-03-13T01:28:41.829924Z"
},
"status_history": [
{
"label": "Qualified",
"status": null,
"changed_at": "2026-03-12T01:28:41.829924Z"
},
{
"label": "Quoted",
"status": "quote_sent",
"changed_at": "2026-03-12T01:43:41.829924Z"
},
{
"label": "Accepted",
"status": "accepted",
"changed_at": "2026-03-13T01:28:41.829924Z"
}
],
"created_at": "2026-03-12T01:28:41.829924Z",
"last_activity_at": "2026-03-12T01:28:41.829924Z"
}
],
"pagination": {
"limit": 25,
"cursor": null,
"next_cursor": "HR_tok_example_next_cursor",
"has_more": true
}
}
GET /api/v2/organizations/{organization_id}/sales/{sale_id}
{
"sale_id": "HR_id_example_sale_id",
"associated_conversation_ids": [
"HR_id_example_conversation_id"
],
"company_id": "HR_id_example_company_id",
"owner_id": "HR_id_example_agent_id",
"associated_contacts": [
{
"contact_id": "HR_id_example_contact_id",
"is_primary": true
}
],
"quote_details": {
"output": {
"currency": "USD",
"total_price": "1200.00"
},
"arguments": {
"products": [
{
"quantity": 1,
"unit_price": "1200.00",
"product_name": "Legacy Seed Service"
}
]
}
},
"custom_fields": {
"notes": "Backfilled sale for new sales framework compatibility."
},
"current_status": {
"label": "Accepted",
"status": "accepted",
"changed_at": "2026-03-13T01:28:41.829924Z"
},
"status_history": [
{
"label": "Qualified",
"status": null,
"changed_at": "2026-03-12T01:28:41.829924Z"
},
{
"label": "Quoted",
"status": "quote_sent",
"changed_at": "2026-03-12T01:43:41.829924Z"
},
{
"label": "Accepted",
"status": "accepted",
"changed_at": "2026-03-13T01:28:41.829924Z"
}
],
"created_at": "2026-03-12T01:28:41.829924Z",
"last_activity_at": "2026-03-12T01:28:41.829924Z"
}
Legacy v1 Routes
GET /api/v1/solutions
[
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Roofing"
}
]
GET /api/v1/solutions/{solution_id}/analytics
{
"responseRateStats": {
"numChatsSent": 0,
"numPendingChats": 0,
"responseRate": 0
},
"responseTimeStats": {
"responseTime": 0,
"responseTimeBusinessHours": 0,
"numResponses": 0,
"numResponsesBusinessHours": 0
},
"salesStats": {
"averageSpeedToSale": 0,
"numSalesCounted": 0
},
"valueStats": {
"salesValue": 0,
"quoteValue": 0
},
"salesFunnelStats": {
"source": {
"sessionsDirectEmail": 0,
"sessionsIndirectEmail": 0,
"sessionsFormRequest": 0
},
"response": {
"sessionsLeadResponded": 0,
"sessionsGhosted": 0,
"sessionsResponseSent": 0,
"sessionsPendingOutreach": 0
},
"outcome": {
"sessionsQuoted": 0
},
"sale": {
"sessionsSale": 0
}
},
"autonomyRateStats": {
"chatsSentWithChanges": 0,
"chatsSentWithoutChanges": 0,
"autonomyRate": 0
},
"numLeads": 0,
"leadsHandled": 0,
"salesRate": 0,
"quoteRate": 0,
"ghostRate": 0,
"leadResponseScore": 0
}