Skip to content

Get Mailbox Associated Sequences

GET
/mailboxes/{mailbox_id}/associated-sequences

Every sequence that references this mailbox, at any status.

Check this before archiving or cancelling a mailbox - the app blocks those actions while a sequence is still wired to it, and a rebuilt UI needs the same signal to avoid silently breaking a live send.

Exposed as GET rather than the app’s POST: it reads and has no body. The app’s POST is left untouched.

Authorizations

Parameters

Path Parameters

mailbox_id
required

Mailbox id.

integer
>= 1

Mailbox id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Sequences wired to a mailbox, at ANY status.

has_associations is the field to branch on before archiving or cancelling - it is true whenever the list is non-empty, including for draft and terminated sequences, which is exactly how the app gates those actions.

object
has_associations
boolean
sequences
Array<object>
object
id
Any of:
integer
status
Any of:
string
title
Any of:
string
key
additional properties
any
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
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