Skip to content

List Mailbox Associated Sequences

POST
/inbox/mailboxes/associated-sequences

Which sequences have threads in these mailboxes.

A POST because the mailbox list is a body; it reads and writes nothing, so it gates on inbox:read.

Keyed by mailbox ADDRESS. /mailboxes/{mailbox_id}/associated-sequences is the same question asked of one mailbox by its numeric id - a different key, which is why this is not folded into it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A list of mailbox addresses to look something up for.

object
mailboxes
required

Mailbox addresses. An empty list returns an empty result.

Array<string>

Responses

200

Successful Response

object
data
required

An open LIST envelope: a bare list, or a named list, is reachable as items, and every other key the app returned (totals, pagination) is kept.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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