Retrieve a segment
GET
/segments/{id}Authorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Path parameters
idstring<uuid>requiredResponses
200
Segment
objectstringrequiredAllowed:
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_atstringrequiredcontact_countnumberrequired401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired404
Not found
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired