Communications API
Build client communication and operator review workflows through Conduitt's communications domain.
The communications API shows the operational timeline around a receivable: client threads, replies, internal notes, tasks, attachments, routes, SLAs, automation review, and delivery state.
/v1/communications/inboxCommon Workflows
| Method | Path | Purpose |
|---|---|---|
GET | /v1/communications/inbox/capabilities | discover supported inbox capabilities |
GET | /v1/communications/inbox/threads | list client communication threads |
GET | /v1/communications/inbox/threads/{threadId} | retrieve a thread |
GET | /v1/communications/inbox/threads/{threadId}/timeline | read the communication and action timeline |
POST | /v1/communications/inbox/threads/{threadId}/reply | send a reply |
POST | /v1/communications/inbox/timeline/{timelineEntryId}/notes | add an internal note |
GET | /v1/communications/inbox/tasks | list operator tasks |
The generated OpenAPI reference documents the complete communications contract. It covers client context, attachments, routes, webhooks, knowledge, configuration, analytics, imports, and agent-review operations.
Request and Response Coverage
Every communications operation in the interactive reference contains:
- its full
/v1/communications/inbox/...path and stable operation ID - endpoint-specific path, query, and JSON request schemas
- needed, optional, nullable, enum, length, array, and format constraints
- the named success response schema and status code
- retry, ownership, operator-review, side-effect, and cache-refresh guidance
Thread lists use the documented pagination and filter schema. Resource mutations return the server-authoritative resource or action result. Imports, bulk actions, workflow runs, webhooks, and agent actions can return partial or asynchronous state. Check every status, count, and per-record result in the response.
The generic inbox envelopes are still typed contracts. Single resources use data. Non-paginated arrays use data. Paginated lists use data plus meta. Deletes return success with an optional resource ID. Endpoint-specific schemas add their concrete fields and constraints.
Keep replies to the client separate from internal notes and discussions. For automated actions, call the available preview, eligibility, policy, and approval endpoints before execution.