Retrieve a segment
GET
/segments/{id}Autorisation
AuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
Paramètres de chemin
idstring<uuid>requisRéponses
200
Segment
objectstringrequisValeurs autorisées :
segmentidstring<uuid>requisnamestringrequisdomain_idstring<uuid> | nullrequisBillionSend extension: the domain the segment is bound to; null for a team-wide segment
filterSegmentFilter | nullrequisAfficher les propriétésMasquer les propriétés
matchstringrequisValeurs autorisées :
allanyconditionsobject[]requismax 50 éléments
Afficher les propriétésMasquer les propriétés
Tableau de
objectfieldstringrequisopstringrequisvaluestring | nullrequislongueur max 500
created_atstringrequiscontact_countnumberrequis401
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequis404
Not found
statusCodenumberrequisnamestringrequismessagestringrequis429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis