Contatos: listas

Listar listas

Todas as listas da conta, da mais antiga à mais nova, opcionalmente com a contagem de membros.

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

Precisa do scope contact:read na sua API key.

Argumentos

  • with_statsbooleanopcional

    Adiciona stats (membros, sendable, aberturas, cliques) a cada lista.

  • include_deletingbooleanopcional

    Também retorna listas que foram excluídas e ainda estão sendo limpas.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "list_lists",
        args: {
          with_stats: true
        }
      }
    ]
  },
  { 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_lists",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "lists": [
          {
            "list_id": "customers",
            "name": "Customers",
            "description": "Everyone who bought at least once",
            "source": "checkout",
            "status": "ready",
            "custom": {
              "origin": "checkout",
              "year": 2026
            },
            "created_at": "2026-10-01T10:00:00.000Z",
            "updated_at": "2026-10-12T15:22:41.000Z",
            "stats": {
              "total": 1834,
              "ok": 1790,
              "opened": 912,
              "clicked": 233
            }
          }
        ]
      }
    }
  ]
}

Campos da resposta

  • lists[].list_id

    O id que você usa em todos os comandos de lista.

  • lists[].name / description / source

    Os atributos que você definiu ao criar ou atualizar a lista.

  • lists[].status

    ready, ou deleting enquanto uma lista excluída está sendo limpa.

  • lists[].custom

    Seus próprios dados, até 50 chaves.

  • lists[].stats

    Só com with_stats. total de membros, ok membros que podem receber envios, e membros que já opened ou clicked.

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…

  • CMDINTERNAL

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