Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List segments

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
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

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.

Responses
200

Segments

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
objectstringrequired
Allowed:segment
idstring<uuid>required
namestringrequired
domain_idstring<uuid> | nullrequired

BillionSend extension: the domain the segment is bound to; null for a team-wide segment

filterSegmentFilter | nullrequired
Show properties
matchstringrequired
Allowed:allany
conditionsobject[]required
max items 50
Show properties
Array of object
fieldstringrequired
opstringrequired
valuestring | nullrequired
max length 500
created_atstringrequired
has_morebooleanrequired
401

Missing, malformed, unknown or revoked API key

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' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "object": "segment",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
      "filter": {
        "match": "all",
        "conditions": [
          {
            "field": "string",
            "op": "string",
            "value": "string"
          }
        ]
      },
      "created_at": "string"
    }
  ],
  "has_more": true
}

Was this page helpful?