Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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.

GET/segments/{id}/contacts
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstring<uuid>required
Query parameters
limitinteger

Page size, 1-100 (default 20)

min 1 · max 100
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.

includestring

Comma-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.

Responses
200

Contacts the segment resolves to

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
idstring<uuid>required
emailstringrequired
first_namestring | nullrequired
last_namestring | nullrequired
created_atstringrequired
unsubscribedbooleanrequired

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[]required

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}.

Show properties
Array of object
domain_idstring<uuid> | nullrequired

Null when the domain has since been deleted from the team

namestringrequired

The domain's name

unsubscribed_atstringrequired
verification_statusstring | nullrequired

BillionSend extension: the verdict of the contact's last deep verification (POST /verifications); null while it was never verified

Allowed:validinvalidriskycatchallroledisposableunknownnull
verified_atstring | nullrequired

When the last deep verification finished; null while never verified

propertiesobject

Present with include=properties

topicsobject[]

Present with include=topics

Show properties
Array of object
idstring<uuid>required
namestringrequired
descriptionstring | nullrequired
subscriptionstringrequired

Effective choice: the contact's explicit one, else the topic's default

Allowed:opt_inopt_out
explicitbooleanrequired

True when the contact or the API chose this; false when it is the topic's default

visibilitystringrequired

The hosted preference page lists public topics only

Allowed:publicprivate
has_morebooleanrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08/contacts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "created_at": "string",
      "unsubscribed": true,
      "unsubscribed_domains": [
        {
          "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
          "name": "string",
          "unsubscribed_at": "string"
        }
      ],
      "verification_status": "valid",
      "verified_at": "string",
      "properties": {
        "property1": {
          "type": "string",
          "value": "string"
        },
        "property2": {
          "type": "string",
          "value": "string"
        }
      },
      "topics": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "description": "string",
          "subscription": "opt_in",
          "explicit": true,
          "visibility": "public"
        }
      ]
    }
  ],
  "has_more": true
}

Was this page helpful?