Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Retrieve a segment

GET/segments/{id}
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstring<uuid>requis
Réponses
200

Segment

objectstringrequis
Valeurs autorisées :segment
idstring<uuid>requis
namestringrequis
domain_idstring<uuid> | nullrequis

BillionSend extension: the domain the segment is bound to; null for a team-wide segment

filterSegmentFilter | nullrequis
Afficher les propriétés
matchstringrequis
Valeurs autorisées :allany
conditionsobject[]requis
max 50 éléments
Afficher les propriétés
Tableau de object
fieldstringrequis
opstringrequis
valuestring | nullrequis
longueur max 500
created_atstringrequis
contact_countnumberrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "object": "segment",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "filter": {
    "match": "all",
    "conditions": [
      {
        "field": "string",
        "op": "string",
        "value": "string"
      }
    ]
  },
  "created_at": "string",
  "contact_count": 0
}

Cette page vous a-t-elle été utile ?