Inbox

List conversations

Replies, bounces and unsubscribes across every campaign, newest first. Texts are cut to 400 characters here; open a conversation for the full text.

The inbox holds the newest 500 conversations per query; filter by campaign or folder to reach older ones.

CostWhat it doesKey scopes
FreeReads onlyargorant:read_counts
get/api/v1/inbox

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/inbox
  • Auth: HTTP bearer

Query parameters

folder'all' | 'replies' | 'interested' | 'not_interested' | 'out_of_office' | 'bounces' | 'unsubscribes'

Which conversations.

campaign_idstring uuid

Only this campaign.

classificationstring

Only this status, any key from GET /api/v1/reply-statuses.

qstring

Search subject, text, sender and company.

limitinteger

Rows per page, 1 to 500 (default 100).

cursorstring

The next_cursor of the previous page. Leave out for the first page.

offsetinteger

Rows to skip, as an alternative to cursor.

Headers

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Response

OK

totalinteger nullable required

How many rows exist in total for this query.

limitinteger required

Rows per page in this answer.

offsetinteger required

Rows skipped before this page.

next_cursorstring nullable required

Pass as cursor to get the next page. null on the last page.

has_moreboolean required

true when another page exists.

total_is_estimateboolean

Present and true when total is a lower bound, for example when a list reached its upper size.

Changes

No recorded changes to this operation across all 1 revision of this API.