ZaplinDocs
GuiasReferência da APIMCPChangelogAbrir o app

Listar contatos do segmento

GET
/v1/segments/{id}/contacts

Os contatos de um segmento ou lista.

Escopo: segments:read

Autorização

bearer segments:read
headerAutorizaçãoBearer <token>

A chave de API de uma conta de serviço (sk_live_…, 600 requisições por minuto cada) ou um access token OAuth para o recurso /api/v1 (600 requisições por minuto por conexão).

Escopo: segments:read

Parâmetros de caminho

id*string

O id.

Parâmetros de query

limit?integer

Itens por página, de 1 a 100.

Intervalo1 <= value <= 100
Padrão50
cursor?string

O next_cursor da página anterior.

Corpo da resposta

Uma página, do mais novo ao mais antigo.

application/json
  1. response
data*array<>
next_cursor*|

O cursor da próxima página, ou null na última.

Exemplo de requisição
curl -X GET 'https://app.zaplin.com.br/api/v1/segments/string/contacts' \  -H 'Authorization: Bearer sk_live_...'
Exemplo de resposta
{  "data": [    {      "id": "string",      "name": "string",      "phone": "string",      "email": "string",      "opted_out": false,      "created_at": "2026-10-17T12:00:00.000Z"    }  ],  "next_cursor": "string"}