List inbox messages
Inbox messages: matched replies by default, filters by classification, mailbox, campaign.
GET/api/v1/inbox
Parameters
Query
| Name | In | Description |
|---|---|---|
view | query | replies, other or all. |
classification | query | interested, meeting_request, information_request, not_interested, out_of_office, unsubscribe, bounce, other. |
mailbox_id | query | Mailbox. |
campaign_id | query | Campaign. |
q | query | Search text. |
limit | query, integer | Rows. |
offset | query, integer | Offset. |
Example
curl
curl -X GET "https://crm.ashwanth.dev/api/v1/inbox" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY"CLI
sales-engine inbox listResponse
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