List inbox threads
List inbox threads grouped by contact.
Required parameters:
- None
Optional query parameters:
-
page: 1-based page number. Defaults to 1.
-
pageSize: number of threads per page. Defaults to 25.
-
search: free-text search across contact name, company name, email, and recent message content.
-
senderIdentityId: scope the inbox to a single sender identity when the same contact appears in multiple sender mailboxes
-
tagId: return only threads tagged with this inbox tag ID. Look up tag IDs via GET /v1/inbox/tags
-
archived: set to true to return archived threads instead of active ones. Defaults to false.
Required scope:
MESSAGING_READRate limit: 100 requests per minute
Authorizations
Query Parameters
1-based page number. Defaults to 1.
1
Number of threads per page. Defaults to 25. Maximum is 100.
x <= 10025
Free-text search across contact name, company name, email, and recent message content.
"pricing northstar"
Scope the inbox to one sender identity when the same contact appears in multiple sender mailboxes.
14
Return only threads tagged with this inbox tag ID. Look up tag IDs via GET /v1/inbox/tags.
13014
Return archived threads instead of active ones. Defaults to false.
false