Contatos: listas

Listar membros

Percorra os membros de uma lista em ordem de email, opcionalmente só os que podem receber envios. O jeito mais rápido de exportar ou enviar para uma lista inteira.

POSThttps://g.sendcorex.com/v1/contactscommand: list_members
i

Precisa do scope contact:read na sua API key.

Argumentos

  • list_idstringobrigatório

    A lista.

    ex.: "customers"

  • sendable_onlybooleanopcional

    Só membros inscritos na lista e com status subscribed. Filtrado no servidor.

  • hydratebooleanopcional

    Adiciona o contato inteiro a cada membro. Reduz o limit máximo para 1000.

  • limitnumberopcional

    Tamanho da página, de 1 a 5000 (1000 com hydrate). Padrão: 100.

  • cursorstringopcional

    O next_cursor da página anterior.

  • selectstring[]opcional

    Com hydrate, retorna só estas partes de cada contato, por exemplo ["first_name", "fields.plan"]. email sempre volta.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "list_members",
        args: {
          list_id: "customers",
          sendable_only: true,
          limit: 1000
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "list_members",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "members": [
          {
            "email": "ana@acme.com",
            "sendable": true,
            "subscribed": true,
            "added_at": "2026-10-13T06:05:08.323Z"
          },
          {
            "email": "bob@gmail.com",
            "sendable": true,
            "subscribed": true,
            "added_at": "2026-10-13T06:05:08.323Z"
          }
        ],
        "has_more": true,
        "next_cursor": "eyJsIjoiY3VzdG9tZXJzIn0"
      }
    }
  ]
}

Campos da resposta

  • members[].email

    O email do membro.

  • members[].subscribed

    Inscrito nesta lista.

  • members[].sendable

    Inscrito nesta lista e com status subscribed.

  • members[].added_at

    Quando o contato entrou na lista.

  • members[].contact

    O contato. Só com hydrate.

  • has_more / next_cursor

    Paginação. Envie next_cursor como cursor para obter a próxima página.

Com o contato inteiro

Com hydrate: true, cada membro também traz contact. Adicione select para manter o payload pequeno, por exemplo só o nome e um campo que você usa no email.

Um membro hidratado

{
  "email": "ana@acme.com",
  "sendable": true,
  "subscribed": true,
  "added_at": "2026-10-13T06:05:08.323Z",
  "contact": {
    "email": "ana@acme.com",
    "first_name": "Ana",
    "fields": {
      "plan": "pro"
    }
  }
}

List Members ou Query Contacts?

List Members lê uma lista em ordem de email, o mais rápido possível. Quando você também filtra por tag, campo ou engajamento, use Query Contacts com list no where.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.

  • CMDINVALID_ARGS

    Um argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…

  • CMDNOT_FOUND

    O contato, a lista, o campo ou o segmento não existe.

  • CMDINVALID_CURSOR

    O cursor está malformado ou pertence a outra consulta ou conta.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.