List unsubscribes
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.
/unsubscribesAuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
limitintegerPage 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.
domain_idstring<uuid>Only opt-outs from this domain (one of your domains); omitted lists every opt-out of the team, whole-team ones included
Opt-outs, newest first, optionally of one domain (domain_id). A row with domain null opts the address out of every domain of the team. Rows whose address was erased (GDPR/LGPD) keep blocking marketing mail but are hidden from the list; they are reachable by id only.
objectstringobrigatóriolistdataobject[]obrigatórioMostrar propriedadesOcultar propriedades
objectidstring<uuid>obrigatórioemailstringobrigatórioThe address; a tombstone for a recipient erased under GDPR/LGPD
domain_idstring<uuid> | nullobrigatórioThe domain the opt-out is for; null for the whole team, or once that domain was deleted
domainstring | nullobrigatórioThe domain's name; null for the whole team. A deleted domain's name stays, and its opt-outs apply again if the domain is added back
created_atstringobrigatóriohas_morebooleanobrigatórioMissing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioA key held to one domain asked for another domain's opt-outs
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioValidation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório