Contatos: listas
Obter lista
Uma lista com seus atributos e contadores em tempo real: membros, membros que podem receber envios e membros que abriram ou clicaram.
https://g.sendcorex.com/v1/contactscommand: get_listPrecisa do scope contact:read na sua API key.
Argumentos
list_idstringobrigatórioO id da lista.
ex.:
"customers"
Início 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);Resposta
{
"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 da resposta
stats.totalContatos na lista.
stats.okContatos que podem receber envios: inscritos na lista e com status
subscribed.stats.opened / clickedMembros que abriram ou clicaram ao menos uma vez.
Os contadores são em tempo real
Os contadores são atualizados a cada mudança em um membro, então lê-los não percorre a lista. Uma lista sendo excluída responde NOT_FOUND.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.
- CMD
INVALID_ARGSUm argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…
- CMD
NOT_FOUNDO contato, a lista, o campo ou o segmento não existe.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.