Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Retrieve a segment

GET/segments/{id}
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
idstring<uuid>erforderlich
Antworten
200

Segment

objectstringerforderlich
Erlaubt:segment
idstring<uuid>erforderlich
namestringerforderlich
domain_idstring<uuid> | nullerforderlich

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

filterSegmentFilter | nullerforderlich
Eigenschaften anzeigen
matchstringerforderlich
Erlaubt:allany
conditionsobject[]erforderlich
max. 50 Elemente
Eigenschaften anzeigen
Array von object
fieldstringerforderlich
opstringerforderlich
valuestring | nullerforderlich
max. Länge 500
created_atstringerforderlich
contact_countnumbererforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "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
}

War diese Seite hilfreich?