Retrieve a segment
GET
/segments/{id}Autorización
AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
Parámetros de ruta
idstring<uuid>obligatorioRespuestas
200
Segment
objectstringobligatorioValores permitidos:
segmentidstring<uuid>obligatorionamestringobligatoriodomain_idstring<uuid> | nullobligatorioBillionSend extension: the domain the segment is bound to; null for a team-wide segment
filterSegmentFilter | nullobligatorioMostrar propiedadesOcultar propiedades
matchstringobligatorioValores permitidos:
allanyconditionsobject[]obligatoriomáx. 50 elementos
Mostrar propiedadesOcultar propiedades
Array de
objectfieldstringobligatorioopstringobligatoriovaluestring | nullobligatoriolongitud máx. 500
created_atstringobligatoriocontact_countnumberobligatorio401
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio404
Not found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio