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
/segmentsAuthorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Query parameters
limitintegerPage 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
objectstringrequiredAllowed:
listdataobject[]requiredShow propertiesHide properties
Array of
objectobjectstringrequiredAllowed:
segmentidstring<uuid>requirednamestringrequireddomain_idstring<uuid> | nullrequiredBillionSend extension: the domain the segment is bound to; null for a team-wide segment
filterSegmentFilter | nullrequiredShow propertiesHide properties
matchstringrequiredAllowed:
allanyconditionsobject[]requiredmax items 50
Show propertiesHide properties
Array of
objectfieldstringrequiredopstringrequiredvaluestring | nullrequiredmax length 500
created_atstringrequiredhas_morebooleanrequired401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired422
Validation error
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired