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
/segmentsAutorisierung
AuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
Query-Parameter
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.
Antworten
200
Segments
objectstringerforderlichErlaubt:
listdataobject[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
Array von
objectobjectstringerforderlichErlaubt:
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_atstringerforderlichhas_morebooleanerforderlich401
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich422
Validation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich