Skip to content

List Inbox

GET
/inbox

List inbox threads across email, SMS, and LinkedIn channels.

status accepts SENT, AI_RESPONDED or DRAFT (case-insensitive) and is forwarded to the channel handler; an unknown value returns 422.

CAVEAT — assignee: this cannot filter by an arbitrary email in this layer. ChannelsService.get_channels only exposes assigned_to_me (a boolean bound to the caller’s identity), so the value is used purely as a trigger to return the caller’s own assigned threads — NOT threads assigned to the requested email. For an org (machine) API key the caller identity is the synthetic [email protected], which owns no threads, so the result is effectively empty. A true per-assignee filter needs an assignee_email field on the shared ChannelRequest (out of scope for the dev-API layer).

Authorizations

Parameters

Query Parameters

channel
Any of:
string
Allowed values: email sms linkedin

Filter by channel: email, sms, linkedin

sequence_id
Any of:
string

Filter by sequence (campaign) ID

status
Any of:
string

Filter by status

assignee
Any of:
string

Filter by assignee email

tag
Any of:
string

Filter by tag ID

page

Page number

integer
default: 1 >= 1

Page number

page_size

Items per page

integer
default: 50 >= 1 <= 100

Items per page

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>
object
assignees
Array<object>
object
key
additional properties
any
channel
required
string
contact
Any of:
object
key
additional properties
any
created_at
Any of:
string
id
required
string
messages
Array<object>
object
content
Any of:
string
date
Any of:
string
from_address
Any of:
string
is_draft
boolean
message_id
Any of:
string
responder
Any of:
string
to_addresses
Array<string>
status
Any of:
string
subject
Any of:
string
tags
Array<object>
object
key
additional properties
any
updated_at
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string