latestOpenAPI 3.0.32026-08-23640164.5 KB

1d888a894943

Inbox

List inbox conversations with filtering and pagination. Workspace admins and owners see conversations from all campaigns in the workspace. Workspace members see only their own campaigns.

get/public/v1/inbox/conversations

Query parameters

view'inbox' | 'archived'

Required. "inbox" for active conversations, "archived" for archived ones.

limitnumber

Maximum number of records to return (1–100, default 20).

offsetnumber

Number of records to skip. Capped at 1,000.

searchstring

Filter by prospect first or last name.

workspaceIdstring

Required. Scope to a specific workspace. Admins and owners see all campaigns in the workspace; members see only their own.

campaignIdsstring

Comma-separated campaign IDs to filter conversations to.

tagIdsstring

Comma-separated tag IDs to filter by.

messageTypestring

Comma-separated message type filters (e.g. INMAIL_SENT, CONNECT_SENT, FOLLOWUP_SENT).

otherMessageType'unread' | 'response_ready' | 'reengagement_sent'

Filter by message state: unread, response_ready, or reengagement_sent.

fromstring

Filter conversations created on or after this date (YYYY-MM-DD).

tostring

Filter conversations created on or before this date (YYYY-MM-DD).

sort'newest' | 'oldest'

Sort order. inbox view: by last_inbound_at (most recent prospect reply first); archived view: by updated_at. Defaults to newest.

prospectInterestLevelstring

Comma-separated interest level values to filter by.

icpFitstring

Comma-separated ICP fit values to filter by (e.g. STRONG,GOOD).

ownerIdstring

Admin/Owner only: scope results to a specific workspace member by their user ID.

Response

Default Response

statusCodenumber
statusboolean
messagestring