Read contacts in bulk
BillionSend extension: returns up to 1000 contacts by id or by email address in one request, in request order, optionally with their properties and topic subscriptions. Entries that match no contact are listed under missing instead of failing the call. One call counts as one request against the rate limit.
/contacts/batch/getAuthorizationBearer 令牌 · header必填A BillionSend API key (bs_…).
application/jsoncontactsobject[]必填Up to 1000 contacts, each by id or by email address (matched case-insensitively)
显示属性隐藏属性
object 数组idstring<uuid>emailstring<email>includestring[]Facets to attach to every contact returned: properties and/or topics
The contacts found, and the entries that matched none
objectstring必填listdataobject[]必填The contacts found, in request order
显示属性隐藏属性
object 数组idstring<uuid>必填emailstring必填first_namestring | null必填last_namestring | null必填created_atstring必填unsubscribedboolean必填Opt-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[]必填BillionSend 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}.
显示属性隐藏属性
object 数组domain_idstring<uuid> | null必填Null when the domain has since been deleted from the team
namestring必填The domain's name
unsubscribed_atstring必填verification_statusstring | null必填BillionSend extension: the verdict of the contact's last deep verification (POST /verifications); null while it was never verified
validinvalidriskycatchallroledisposableunknownnullverified_atstring | null必填When the last deep verification finished; null while never verified
propertiesobjectPresent with include=properties
topicsobject[]Present with include=topics
显示属性隐藏属性
object 数组idstring<uuid>必填namestring必填descriptionstring | null必填subscriptionstring必填Effective choice: the contact's explicit one, else the topic's default
opt_inopt_outexplicitboolean必填True when the contact or the API chose this; false when it is the topic's default
visibilitystring必填The hosted preference page lists public topics only
publicprivateobjectstring必填contactmissingobject[]必填Request entries that matched no contact of the team
显示属性隐藏属性
object 数组indexinteger必填Position in the request's contacts array
idstring<uuid>emailstringMissing, malformed, unknown or revoked API key
statusCodenumber必填namestring必填messagestring必填Validation error
statusCodenumber必填namestring必填messagestring必填Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumber必填namestring必填messagestring必填