Receber emails: Contatos e público
Listar segmentos
Lista os segmentos salvos desta caixa, com os campos personalizados e os totais. Só leitura.
https://g.sendcorex.com/v1command: list_segmentsArgumentos
Este endpoint não recebe argumentos.
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "list_segments"
}
]
},
{ 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_segments",
"id": "0",
"type": "SUCCESS",
"data": {
"segments": [
{
"segment_id": "seg_8Hq2",
"name": "Opened in 30 days",
"where": {
"last_open_at": {
"within_days": 30
}
},
"sort": null,
"created_at": "2026-11-21T10:00:00Z",
"updated_at": "2026-11-21T10:00:00Z"
}
],
"fields": [
{
"key": "plan",
"name": "Plan",
"type": "enum",
"options": [
"free",
"pro"
]
}
],
"stats": {
"total": 1240
}
}
}
]
}Campos da resposta
segments[]segment_id,name,where,sort,created_ateupdated_at.fieldsCampos personalizados da conta. São criados no dashboard.
statsTotais de contatos desta caixa.
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
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.