Contacts : listes

Lister les membres

Parcourez les membres d'une liste dans l'ordre des emails, éventuellement uniquement ceux qui sont joignables. Le moyen le plus rapide d'exporter ou d'envoyer à toute une liste.

POSThttps://g.sendcorex.com/v1/contactscommand: list_members
i

Nécessite le scope contact:read sur votre API key.

Arguments

  • list_idstringobligatoire

    La liste.

    ex. : "customers"

  • sendable_onlybooleanfacultatif

    Uniquement les membres abonnés à la liste et avec le statut subscribed. Filtré côté serveur.

  • hydratebooleanfacultatif

    Ajoute le contact complet à chaque membre. Réduit le limit maximal à 1000.

  • limitnumberfacultatif

    Taille de page, de 1 à 5000 (1000 avec hydrate). 100 par défaut.

  • cursorstringfacultatif

    Le next_cursor de la page précédente.

  • selectstring[]facultatif

    Avec hydrate, ne renvoie que ces parties de chaque contact, par exemple ["first_name", "fields.plan"]. email revient toujours.

Démarrage rapide

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);

Réponse

{
  "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"
      }
    }
  ]
}

Champs de la réponse

  • members[].email

    L'email du membre.

  • members[].subscribed

    Abonné à cette liste.

  • members[].sendable

    Abonné à cette liste et avec le statut subscribed.

  • members[].added_at

    Quand le contact a rejoint la liste.

  • members[].contact

    Le contact. Uniquement avec hydrate.

  • has_more / next_cursor

    Pagination. Envoyez next_cursor comme cursor pour obtenir la page suivante.

Avec le contact complet

Avec hydrate: true, chaque membre inclut aussi contact. Ajoutez select pour garder un payload léger, par exemple uniquement le nom et un champ utilisé dans l'email.

Un membre hydraté

{
  "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 ou Query Contacts ?

List Members lit une liste dans l'ordre des emails, aussi vite que possible. Si vous filtrez aussi par tag, champ ou engagement, utilisez Query Contacts avec list dans le where.

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.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.

  • 429RATE_LIMITED

    Plus 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.

  • CMDMISSING_SCOPE

    L'API key n'a pas le scope requis par cette commande. Les autres commandes de la requête s'exécutent quand même.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide : email, valeur de champ, option d'enum, clé de where, id de liste…

  • CMDNOT_FOUND

    Le contact, la liste, le champ ou le segment n'existe pas.

  • CMDINVALID_CURSOR

    Le cursor est mal formé ou appartient à une autre requête ou à un autre compte.

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.