Receber emails: Contatos e público
Listar contatos
Lista as pessoas que conversam com esta caixa, com os mesmos filtros do dashboard. Só leitura.
https://g.sendcorex.com/v1command: list_contactsArgumentos
whereobjectopcionalFiltros: status, tags, domínio, aberturas e cliques, datas e campos personalizados. Mesmo formato dos contatos do dashboard.
sortobjectopcional{ field }:email,created_at,last_open_at,last_click_at,open_countouclick_count.limitnumberopcionalTamanho da página, de 1 a 100.
cursorstringopcionalO
next_cursorda página anterior.
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "list_contacts",
args: {
where: {
last_open_at: {
within_days: 30
}
},
limit: 50
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);
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_contacts",
"id": "0",
"type": "SUCCESS",
"data": {
"contacts": [
{
"email": "ana@empresa.com",
"first_name": "Ana",
"last_name": "Lima",
"status": "subscribed",
"tags": [
"hot"
],
"counts": {
"sent": 4,
"opens": 3,
"clicks": 1
},
"dates": {
"last_open_at": "2026-11-21T09:42:00Z",
"last_click_at": "2026-11-21T09:43:00Z"
},
"trust": "default",
"company": "Empresa",
"lists": [],
"fields": {}
}
],
"has_more": false,
"next_cursor": null
}
}
]
}Campos da resposta
contacts[]Email, nome, empresa, status, tags, listas, campos, contagens, datas e confiança nesta caixa.
has_more / next_cursorPaginação.
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
TOKEN_EXPIREDO access token expirou. Chame Refresh Token e repita a requisição.
- 401
INVALID_TOKENO token está malformado, é desconhecido ou foi revogado.
- 429
RATE_LIMITEDMais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.
- CMD
INVALID_ARGSUm argumento obrigatório está ausente ou é inválido.
- CMD
INVALID_CURSORO cursor está malformado ou pertence a outra conta ou pasta.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.