Contactos: listas
Listar miembros
Recorre los miembros de una lista en orden de email, opcionalmente solo aquellos a los que puedes enviar. La forma más rápida de exportar o enviar a una lista entera.
https://g.sendcorex.com/v1/contactscommand: list_membersNecesita el scope contact:read en tu API key.
Argumentos
list_idstringobligatorioLa lista.
p. ej.
"customers"sendable_onlybooleanopcionalSolo miembros suscritos a la lista y con estado
subscribed. Se filtra en el servidor.hydratebooleanopcionalAñade el contacto completo a cada miembro. Reduce el
limitmáximo a 1000.limitnumberopcionalTamaño de página, de 1 a 5000 (1000 con
hydrate). Por defecto, 100.cursorstringopcionalEl
next_cursorde la página anterior.selectstring[]opcionalCon
hydrate, devuelve solo estas partes de cada contacto, por ejemplo["first_name", "fields.plan"].emailsiempre vuelve.
Inicio 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);Respuesta
{
"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 de la respuesta
members[].emailEl email del miembro.
members[].subscribedSuscrito a esta lista.
members[].sendableSuscrito a esta lista y con estado
subscribed.members[].added_atCuándo se unió el contacto a la lista.
members[].contactEl contacto. Solo con
hydrate.has_more / next_cursorPaginación. Envía
next_cursorcomocursorpara obtener la página siguiente.
Con el contacto completo
Con hydrate: true, cada miembro trae también contact. Añade select para mantener el payload pequeño, por ejemplo solo el nombre y un campo que uses en el email.
Un miembro 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 o Query Contacts?
List Members lee una lista en orden de email, lo más rápido posible. Si además filtras por etiqueta, campo o interacción, usa Query Contacts con list en el where.
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.
- 401
INVALID_API_KEYLa API key no existe, se revocó o se desactivó en el dashboard.
- 429
RATE_LIMITEDMás de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.
- CMD
MISSING_SCOPELa API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.
- CMD
INVALID_ARGSFalta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…
- CMD
NOT_FOUNDEl contacto, la lista, el campo o el segmento no existe.
- CMD
INVALID_CURSOREl cursor tiene un formato incorrecto o pertenece a otra consulta o cuenta.
- CMD
INTERNALError del servidor. El detalle solo se escribe en el log del servidor.