Kontakte: Listen

Listen auflisten

Alle Listen des Kontos, älteste zuerst, optional mit Mitgliederzahlen.

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

Erfordert den Scope contact:read auf Ihrem API Key.

Argumente

  • with_statsbooleanoptional

    Fügt jeder Liste stats hinzu (Mitglieder, anschreibbar, geöffnet, geklickt).

  • include_deletingbooleanoptional

    Gibt auch gelöschte Listen zurück, die noch bereinigt werden.

Schnellstart

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

Antwort

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

Antwortfelder

  • lists[].list_id

    Die ID, die Sie in jedem Listenbefehl verwenden.

  • lists[].name / description / source

    Die Attribute, die Sie beim Anlegen oder Aktualisieren der Liste gesetzt haben.

  • lists[].status

    ready oder deleting, solange eine gelöschte Liste bereinigt wird.

  • lists[].custom

    Ihre eigenen Daten, bis zu 50 Schlüssel.

  • lists[].stats

    Nur mit with_stats. total Mitglieder, ok anschreibbare Mitglieder sowie Mitglieder, die je opened oder clicked haben.

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 …

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.