Batch Contact Related
POST /contacts/related
Sequences and/or lists for up to 100 contacts in ONE request. Writes nothing.
Use this instead of looping GET /contacts/{contact_id}/sequences or
/lists per contact: the loop spends one rate-limit slot per contact and
hits 429 on a large book; this spends one per 100.
Each contact gets exactly what its per-contact route returns, through the
same access check. A contact that does not exist or is outside the key’s
scope for any requested include comes back found: false with no related
records, rather than failing the batch. POST only because the ids are a
body; it is tiered as a read.
Authorizations
Parameters
Header Parameters
Request Body required
Which contacts, and which of their related records, to read in one call.
object
Up to 100 contact ids, the same ids the per-contact routes take. Duplicates are read once; the response keeps first-seen order.
Related records to return per contact. sequences matches GET /contacts/{contact_id}/sequences; lists matches GET /contacts/{contact_id}/lists (keyed on the contact primary key).
Responses
200
Successful Response
object
object
One contact’s related records. A field is present only when requested.
object
False when the contact does not exist or is outside this key’s scope (indistinguishable on purpose, like the per-contact 404).
object
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error