All operations
This index lists every REST operation in one place. Select an operation for its parameters, response schema and examples. The MCP tool column gives the tool name an agent calls for the same operation; tools and REST share inputs, permissions and quotas.
Discovery
Section titled “Discovery”Installation context, granted websites, capabilities, guides and write receipts.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| Get a write receipt | GET /api/v1/operations/{operation_id} |
operation_get |
– | – | – |
| List granted websites | GET /api/v1/websites |
websites_list |
website_read |
– | – |
| List capabilities for a website | GET /api/v1/capabilities |
capabilities_list |
– | – | – |
| Check website readiness | GET /api/v1/health |
health |
health_read |
– | – |
| Get installation context | GET /api/v1/context |
gateway_context |
– | – | – |
| Read a guide | GET /api/v1/guides/{guide} |
guide_read |
– | – | – |
Conversations
Section titled “Conversations”Stored conversations, transcripts, messages and dispositions.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| List conversations | GET /api/v1/conversations |
conversations_list |
conversation_read |
– | contact_id adds contact_read, contact_read_pii; query adds message_content_read, contact_read_pii |
| Get a conversation | GET /api/v1/conversations/{conversation_id} |
conversation |
conversation_read |
– | – |
| List contacts linked to a conversation | GET /api/v1/conversations/{conversation_id}/contacts |
conversation_contacts |
conversation_read, contact_read, contact_read_pii |
pii |
– |
| Get a message | GET /api/v1/conversations/{conversation_id}/messages/{message_id} |
conversation_message |
conversation_read, message_content_read, contact_read_pii |
message_content, pii |
include_internal adds internal_notes_read |
| List conversation messages | GET /api/v1/conversations/{conversation_id}/messages |
conversation_messages |
conversation_read, message_content_read, contact_read_pii |
message_content, pii |
include_internal adds internal_notes_read |
| Set a conversation disposition | POST /api/v1/conversations/{conversation_id}/disposition |
conversation_disposition_set |
conversation_read, conversation_update |
– | Write; Idempotency-Key required; mapped native author |
Visitors
Section titled “Visitors”Stored visitors, their conversation history and visitor notes.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| Get a visitor | GET /api/v1/dashboard/visitors/{visitor_id} |
visitor |
conversation_read |
– | – |
| List visitor conversations | GET /api/v1/dashboard/visitors/{visitor_id}/conversations |
visitor_conversations |
conversation_read |
– | – |
| List visitor notes | GET /api/v1/visitors/{visitor_id}/notes |
visitor_notes |
conversation_read, visitor_notes_read, contact_read_pii |
message_content, pii, internal_notes |
– |
| Add a visitor note | POST /api/v1/visitors/{visitor_id}/notes |
visitor_note_add |
conversation_read, visitor_notes_write, message_content_read, contact_read_pii |
message_content, pii, internal_notes |
Write; Idempotency-Key required; mapped native author |
Contacts
Section titled “Contacts”Stored contacts, linked visitors and contact notes.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| List contacts | GET /api/v1/contacts |
contacts_list |
contact_read |
– | query adds contact_read_pii |
| Get a contact | GET /api/v1/contacts/{contact_id} |
contact_get |
contact_read |
– | – |
| List visitors linked to a contact | GET /api/v1/contacts/{contact_id}/visitors |
contact_visitors |
contact_read, contact_read_pii, conversation_read |
pii |
– |
| List contact notes | GET /api/v1/contacts/{contact_id}/notes |
contact_notes |
contact_read, contact_read_pii, conversation_read, visitor_notes_read |
message_content, pii, internal_notes |
– |
Message attachment metadata and bounded content reads.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| Read file content | GET /api/v1/files/{file_id}/content |
file_content |
file_read, conversation_read, message_content_read, contact_read_pii |
message_content, pii |
include_internal adds internal_notes_read |
| Get file metadata | GET /api/v1/files/{file_id} |
file_get |
file_read, conversation_read, message_content_read, contact_read_pii |
message_content, pii |
include_internal adds internal_notes_read |
| List message attachments | GET /api/v1/conversations/{conversation_id}/messages/{message_id}/attachments |
conversation_message_attachments |
file_read, conversation_read, message_content_read, contact_read_pii |
message_content, pii |
include_internal adds internal_notes_read |
Directory and catalogues
Section titled “Directory and catalogues”Operators, channels, teams, dispositions, saved responses, saved links and offers.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| List operators | GET /api/v1/operators |
operators |
directory_read, contact_read_pii |
pii |
– |
| List dispositions | GET /api/v1/dispositions |
dispositions |
conversation_read |
– | – |
| List saved responses | GET /api/v1/saved_responses |
saved_responses |
conversation_read |
– | – |
| List saved links | GET /api/v1/saved_links |
saved_links |
conversation_read |
– | – |
| List offers | GET /api/v1/offers |
offers |
conversation_read |
– | – |
| List channels | GET /api/v1/channels |
channels |
live_read |
– | – |
| List teams | GET /api/v1/teams |
teams |
live_read |
– | – |
Reporting
Section titled “Reporting”Aggregated reports over stored conversations.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| Get the AI conversation summary | GET /api/v1/analytics/ai-conversations/summary |
ai_conversation_summary |
reports_read, conversation_read |
– | – |
AI features
Section titled “AI features”Configured AI feature metadata and typed execution.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| List AI features | GET /api/v1/ai/features |
ai_features_list |
ai_features_read |
– | – |
| Get an AI feature | GET /api/v1/ai/features/{feature_id} |
ai_feature_get |
ai_features_read |
– | – |
| Run an AI feature | POST /api/v1/ai/features/{feature_id}/execute |
ai_feature_execute |
ai_features_read, ai_execute |
– | Write; Idempotency-Key required |
Configuration
Section titled “Configuration”AI feature configuration metadata and dry-run previews.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| List configuration areas | GET /api/v1/settings/catalog |
config_catalog |
config_read |
– | – |
| Get the configuration schema | GET /api/v1/settings/schema |
config_schema |
config_read |
– | – |
| Read configuration | GET /api/v1/settings/item |
config_get |
config_read |
– | – |
| Search configuration | GET /api/v1/settings/search |
config_search |
config_read |
– | – |
| Preview a configuration change | POST /api/v1/settings/plans |
config_plan |
config_read, config_plan |
– | Write; Idempotency-Key required; preview only |
Event subscriptions
Section titled “Event subscriptions”Payload-free change receipts pulled from a subscription.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| List subscriptions | GET /api/v1/subscriptions |
subscriptions_list |
website_read, event_read |
– | – |
| Create a subscription | POST /api/v1/subscriptions |
subscription_create |
website_read, event_read |
– | Write; optional Idempotency-Key |
| Get a subscription | GET /api/v1/subscriptions/{subscription_id} |
subscription_get |
website_read, event_read |
– | – |
| Replace a subscription | PATCH /api/v1/subscriptions/{subscription_id} |
subscription_replace |
website_read, event_read |
– | Write; optional Idempotency-Key; If-Match required |
| Delete a subscription | DELETE /api/v1/subscriptions/{subscription_id} |
subscription_delete |
website_read, event_read |
– | Write; optional Idempotency-Key; If-Match required |
| Pull events | GET /api/v1/events |
events_pull |
website_read, event_read |
– | – |
Realtime
Section titled “Realtime”WebSocket sessions that stream the same change receipts.
| Operation | Endpoint | MCP tool | Required scopes | Data access | Notes |
|---|---|---|---|---|---|
| Create a realtime session | POST /api/v1/realtime/sessions |
– | website_read, event_read |
– | Write; Origin required |
| Issue a reconnect ticket | POST /api/v1/realtime/sessions/{session_id}/tickets |
– | website_read, event_read |
– | Write; Origin required |
| Close a realtime session | DELETE /api/v1/realtime/sessions/{session_id} |
– | website_read, event_read |
– | Write; Origin required |
| Open the realtime socket | GET /api/v1/realtime/sessions/{session_id}/socket |
– | website_read, event_read |
– | WebSocket upgrade; Origin required |