List segment contacts
Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones.
/segments/{id}/contactsAuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
idstring<uuid>erforderlichlimitintegerPage size, 1-100 (default 20)
afterstring<uuid>Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.
beforestring<uuid>Cursor: id of the first item of the current page; returns the previous page; same rule as after.
includestringComma-separated facets attached to every item — properties (the {type, value} map GET /contacts/{id} returns) and topics (the rows GET /contacts/{id}/topics returns). Omitted, each item has only the contact fields.
Contacts the segment resolves to
objectstringerforderlichlistdataobject[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
objectidstring<uuid>erforderlichemailstringerforderlichfirst_namestring | nullerforderlichlast_namestring | nullerforderlichcreated_atstringerforderlichunsubscribedbooleanerforderlichOpt-out from every marketing send of the team, whichever domain sends. A recipient's own unsubscribe never sets it: that is recorded for the domain whose email carried the link (see unsubscribed_domains).
unsubscribed_domainsobject[]erforderlichBillionSend extension: the domains this contact unsubscribed from through a link in their email. Marketing sends from those domains skip the contact; other domains still reach them. The team-wide opt-out is unsubscribed, not an entry here. Remove an entry with DELETE /unsubscribes/{id}.
Eigenschaften anzeigenEigenschaften ausblenden
objectdomain_idstring<uuid> | nullerforderlichNull when the domain has since been deleted from the team
namestringerforderlichThe domain's name
unsubscribed_atstringerforderlichverification_statusstring | nullerforderlichBillionSend extension: the verdict of the contact's last deep verification (POST /verifications); null while it was never verified
validinvalidriskycatchallroledisposableunknownnullverified_atstring | nullerforderlichWhen the last deep verification finished; null while never verified
propertiesobjectPresent with include=properties
topicsobject[]Present with include=topics
Eigenschaften anzeigenEigenschaften ausblenden
objectidstring<uuid>erforderlichnamestringerforderlichdescriptionstring | nullerforderlichsubscriptionstringerforderlichEffective choice: the contact's explicit one, else the topic's default
opt_inopt_outexplicitbooleanerforderlichTrue when the contact or the API chose this; false when it is the topic's default
visibilitystringerforderlichThe hosted preference page lists public topics only
publicprivatehas_morebooleanerforderlichMissing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichNot found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichValidation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich