Kontakte: Listen

Liste abrufen

Eine Liste mit ihren Attributen und Live-Zählern: Mitglieder, anschreibbare Mitglieder und Mitglieder, die geöffnet oder geklickt haben.

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

Erfordert den Scope contact:read auf Ihrem API Key.

Argumente

  • list_idstringerforderlich

    Die ID der Liste.

    z. B. "customers"

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "get_list",
        args: {
          list_id: "customers"
        }
      }
    ]
  },
  { 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": "get_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "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
        }
      }
    }
  ]
}

Antwortfelder

  • stats.total

    Kontakte in der Liste.

  • stats.ok

    Anschreibbare Kontakte: für die Liste angemeldet und mit Status subscribed.

  • stats.opened / clicked

    Mitglieder, die mindestens einmal geöffnet oder geklickt haben.

Die Zähler sind live

Die Zähler werden bei jeder Änderung an einem Mitglied aktualisiert, das Lesen durchläuft die Liste also nicht. Eine Liste, die gerade gelöscht wird, antwortet mit NOT_FOUND.

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.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.