Kontakte: Listen

Mitglieder auflisten

Durchlaufen Sie die Mitglieder einer Liste in E-Mail-Reihenfolge, optional nur die anschreibbaren. Der schnellste Weg, eine ganze Liste zu exportieren oder anzuschreiben.

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

Erfordert den Scope contact:read auf Ihrem API Key.

Argumente

  • list_idstringerforderlich

    Die Liste.

    z. B. "customers"

  • sendable_onlybooleanoptional

    Nur Mitglieder, die für die Liste angemeldet sind und Status subscribed haben. Wird auf dem Server gefiltert.

  • hydratebooleanoptional

    Fügt jedem Mitglied den vollständigen Kontakt hinzu. Senkt das maximale limit auf 1000.

  • limitnumberoptional

    Seitengröße, von 1 bis 5000 (1000 mit hydrate). Standard: 100.

  • cursorstringoptional

    Der next_cursor der vorherigen Seite.

  • selectstring[]optional

    Mit hydrate nur diese Teile jedes Kontakts zurückgeben, zum Beispiel ["first_name", "fields.plan"]. email kommt immer zurück.

Schnellstart

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

Antwort

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

Antwortfelder

  • members[].email

    Die E-Mail des Mitglieds.

  • members[].subscribed

    Für diese Liste angemeldet.

  • members[].sendable

    Für diese Liste angemeldet und mit Status subscribed.

  • members[].added_at

    Wann der Kontakt der Liste beigetreten ist.

  • members[].contact

    Der Kontakt. Nur mit hydrate.

  • has_more / next_cursor

    Paginierung. Senden Sie next_cursor als cursor, um die nächste Seite zu erhalten.

Mit dem vollständigen Kontakt

Mit hydrate: true bringt jedes Mitglied auch contact mit. Fügen Sie select hinzu, um den Payload klein zu halten, zum Beispiel nur den Namen und ein Feld, das Sie in der E-Mail verwenden.

Ein hydratisiertes Mitglied

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

List Members liest eine Liste in E-Mail-Reihenfolge, so schnell es geht. Wenn Sie zusätzlich nach Tag, Feld oder Engagement filtern, verwenden Sie Query Contacts mit list im where.

Fehler

Fehler auf HTTP-Ebene liefern type, code und message. Mit CMD markierte Fehler kommen im Befehlsergebnis zurück, mit HTTP 200.

  • 401INVALID_API_KEY

    Der API Key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.

  • 429RATE_LIMITED

    Mehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API Key. Warten Sie die Sekunden aus Retry-After ab.

  • CMDMISSING_SCOPE

    Dem API Key fehlt der Scope, den dieser Befehl braucht. Die anderen Befehle im Request laufen trotzdem.

  • CMDINVALID_ARGS

    Ein Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …

  • CMDNOT_FOUND

    Der Kontakt, die Liste, das Feld oder das Segment existiert nicht.

  • CMDINVALID_CURSOR

    Der Cursor ist fehlerhaft oder gehört zu einer anderen Abfrage oder einem anderen Konto.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.