Contactos: listas

Obtener lista

Una lista con sus atributos y contadores en vivo: miembros, miembros a los que se puede enviar y miembros que abrieron o hicieron clic.

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

Necesita el scope contact:read en tu API key.

Argumentos

  • list_idstringobligatorio

    El id de la lista.

    p. ej. "customers"

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "get_list",
        args: {
          list_id: "customers"
        }
      }
    ]
  },
  { 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": "get_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "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

  • stats.total

    Contactos en la lista.

  • stats.ok

    Contactos a los que se puede enviar: suscritos a la lista y con estado subscribed.

  • stats.opened / clicked

    Miembros que abrieron o hicieron clic al menos una vez.

Los contadores son en vivo

Los contadores se actualizan con cada cambio en un miembro, así que leerlos no recorre la lista. Una lista en proceso de eliminación responde NOT_FOUND.

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…

  • CMDNOT_FOUND

    El contacto, la lista, el campo o el segmento no existe.

  • CMDINTERNAL

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