Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Retrieve a segment

GET/segments/{id}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
idstring<uuid>obligatorio
Respuestas
200

Segment

objectstringobligatorio
Valores permitidos:segment
idstring<uuid>obligatorio
namestringobligatorio
domain_idstring<uuid> | nullobligatorio

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

filterSegmentFilter | nullobligatorio
Mostrar propiedades
matchstringobligatorio
Valores permitidos:allany
conditionsobject[]obligatorio
máx. 50 elementos
Mostrar propiedades
Array de object
fieldstringobligatorio
opstringobligatorio
valuestring | nullobligatorio
longitud máx. 500
created_atstringobligatorio
contact_countnumberobligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X GET 'https://api.billionsend.com/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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
}

¿Te ha resultado útil esta página?