Skip to main content
GET
List inbox threads

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer

1-based page number. Defaults to 1.

Example:

1

pageSize
integer

Number of threads per page. Defaults to 25. Maximum is 100.

Required range: x <= 100
Example:

25

Free-text search across contact name, company name, email, and recent message content.

Example:

"pricing northstar"

senderIdentityId
integer

Scope the inbox to one sender identity when the same contact appears in multiple sender mailboxes.

Example:

14

tagId
integer

Return only threads tagged with this inbox tag ID. Look up tag IDs via GET /v1/inbox/tags.

Example:

13014

archived
boolean

Return archived threads instead of active ones. Defaults to false.

Example:

false

Response

Successful response with paginated inbox threads

data
object[]
required
meta
object
required