Sales Engine
API documentation
InboxOperation inbox.list

List inbox messages

Inbox messages: matched replies by default, filters by classification, mailbox, campaign.

GET/api/v1/inbox
Scope read: Read anything in the workspace.

Parameters

Query

NameInDescription
viewqueryreplies, other or all.
classificationqueryinterested, meeting_request, information_request, not_interested, out_of_office, unsubscribe, bounce, other.
mailbox_idqueryMailbox.
campaign_idqueryCampaign.
qquerySearch text.
limitquery, integerRows.
offsetquery, integerOffset.

Example

curl
curl -X GET "https://crm.ashwanth.dev/api/v1/inbox" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"
CLI
sales-engine inbox list

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Query
replies, other or all.
interested, meeting_request, information_request, not_interested, out_of_office, unsubscribe, bounce, other.
Mailbox.
Campaign.
Search text.
Rows.
Offset.
Request
GET /api/v1/inbox

Also in Inbox