Retrieve a segment
GET
/segments/{id}Autorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de caminho
idstring<uuid>obrigatórioRespostas
200
Segment
objectstringobrigató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óriocontact_countnumberobrigatório401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório