Retrieve a segment
GET
/segments/{id}Autorisierung
AuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
Pfadparameter
idstring<uuid>erforderlichAntworten
200
Segment
objectstringerforderlichErlaubt:
segmentidstring<uuid>erforderlichnamestringerforderlichdomain_idstring<uuid> | nullerforderlichBillionSend extension: the domain the segment is bound to; null for a team-wide segment
filterSegmentFilter | nullerforderlichEigenschaften anzeigenEigenschaften ausblenden
matchstringerforderlichErlaubt:
allanyconditionsobject[]erforderlichmax. 50 Elemente
Eigenschaften anzeigenEigenschaften ausblenden
Array von
objectfieldstringerforderlichopstringerforderlichvaluestring | nullerforderlichmax. Länge 500
created_atstringerforderlichcontact_countnumbererforderlich401
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich404
Not found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich