Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Retrieve a segment

GET/segments/{id}
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstring<uuid>obrigatório
Respostas
200

Segment

objectstringobrigatório
Valores permitidos:segment
idstring<uuid>obrigatório
namestringobrigatório
domain_idstring<uuid> | nullobrigatório

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

filterSegmentFilter | nullobrigatório
Mostrar propriedades
matchstringobrigatório
Valores permitidos:allany
conditionsobject[]obrigatório
máx. 50 itens
Mostrar propriedades
Array de object
fieldstringobrigatório
opstringobrigatório
valuestring | nullobrigatório
comprimento máx. 500
created_atstringobrigatório
contact_countnumberobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "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
}

Esta página foi útil?