Contacts : listes
Lister les listes
Toutes les listes du compte, de la plus ancienne à la plus récente, avec le nombre de membres en option.
https://g.sendcorex.com/v1/contactscommand: list_listsNécessite le scope contact:read sur votre API key.
Arguments
with_statsbooleanfacultatifAjoute
stats(membres, joignables, ouvertures, clics) à chaque liste.include_deletingbooleanfacultatifRenvoie aussi les listes supprimées qui sont encore en cours de nettoyage.
Démarrage rapide
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "list_lists",
args: {
with_stats: true
}
}
]
},
{ 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);Réponse
{
"type": "SUCCESS",
"results": [
{
"command": "list_lists",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"lists": [
{
"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
}
}
]
}
}
]
}Champs de la réponse
lists[].list_idL'id que vous utilisez dans toutes les commandes de liste.
lists[].name / description / sourceLes attributs définis lors de la création ou de la mise à jour de la liste.
lists[].statusready, oudeletingpendant le nettoyage d'une liste supprimée.lists[].customVos propres données, jusqu'à 50 clés.
lists[].statsUniquement avec
with_stats.totaldes membres,okmembres joignables, et membres ayant déjàopenedouclicked.
Erreurs
Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.
- 401
INVALID_API_KEYL'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.
- 429
RATE_LIMITEDPlus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.
- CMD
MISSING_SCOPEL'API key n'a pas le scope requis par cette commande. Les autres commandes de la requête s'exécutent quand même.
- CMD
INVALID_ARGSUn argument obligatoire est manquant ou invalide : email, valeur de champ, option d'enum, clé de where, id de liste…
- CMD
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.