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
/segmentsAutorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de consulta
limitintegerPage size, 1-100 (default 20)
mín. 1 · máx. 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.
Respostas
200
Segments
objectstringobrigatórioValores permitidos:
listdataobject[]obrigatórioMostrar propriedadesOcultar propriedades
Array de
objectobjectstringobrigatórioValores permitidos:
segmentidstring<uuid>obrigatórionamestringobrigatóriodomain_idstring<uuid> | nullobrigatórioBillionSend extension: the domain the segment is bound to; null for a team-wide segment
filterSegmentFilter | nullobrigatórioMostrar propriedadesOcultar propriedades
matchstringobrigatórioValores permitidos:
allanyconditionsobject[]obrigatóriomáx. 50 itens
Mostrar propriedadesOcultar propriedades
Array de
objectfieldstringobrigatórioopstringobrigatóriovaluestring | nullobrigatóriocomprimento máx. 500
created_atstringobrigatóriohas_morebooleanobrigatório401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório