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

List segments

Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones.

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

A BillionSend API key (bs_…).

Parâmetros de consulta
limitinteger

Page size, 1-100 (default 20)

mín. 1 · máx. 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

Respostas
200

Segments

objectstringobrigatório
Valores permitidos:list
dataobject[]obrigatório
Mostrar propriedades
Array de object
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
has_morebooleanobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

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' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true
}

Esta página foi útil?