Contactos: listas

Listar listas

Todas las listas de la cuenta, de la más antigua a la más reciente, opcionalmente con el número de miembros.

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

Necesita el scope contact:read en tu API key.

Argumentos

  • with_statsbooleanopcional

    Añade stats (miembros, sendable, aperturas, clics) a cada lista.

  • include_deletingbooleanopcional

    También devuelve las listas eliminadas que todavía se están limpiando.

Inicio 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);

Respuesta

{
  "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 de la respuesta

  • lists[].list_id

    El id que usas en todos los comandos de lista.

  • lists[].name / description / source

    Los atributos que definiste al crear o actualizar la lista.

  • lists[].status

    ready, o deleting mientras se limpia una lista eliminada.

  • lists[].custom

    Tus propios datos, hasta 50 claves.

  • lists[].stats

    Solo con with_stats. total de miembros, ok miembros a los que se puede enviar, y miembros que alguna vez opened o clicked.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401INVALID_API_KEY

    La API key no existe, se revocó o se desactivó en el dashboard.

  • 429RATE_LIMITED

    Más de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.

  • CMDMISSING_SCOPE

    La API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.