Kontak: list

Daftar list

Semua list di akun, yang terlama lebih dulu, opsional beserta jumlah anggota.

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

Membutuhkan scope contact:read pada API key Anda.

Argumen

  • with_statsbooleanopsional

    Menambahkan stats (anggota, sendable, membuka, mengklik) ke setiap list.

  • include_deletingbooleanopsional

    Juga mengembalikan list yang sudah dihapus dan masih dibersihkan.

Mulai cepat

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

Respons

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

Field respons

  • lists[].list_id

    Id yang Anda gunakan di setiap perintah list.

  • lists[].name / description / source

    Atribut yang Anda tetapkan saat membuat atau memperbarui list.

  • lists[].status

    ready, atau deleting selama list yang dihapus sedang dibersihkan.

  • lists[].custom

    Data Anda sendiri, hingga 50 key.

  • lists[].stats

    Hanya dengan with_stats. total anggota, ok anggota yang dapat dikirimi, dan anggota yang pernah opened atau clicked.

Error

Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.

  • 401INVALID_API_KEY

    API key tidak ada, sudah dicabut, atau dinonaktifkan di dashboard.

  • 429RATE_LIMITED

    Lebih dari 15 request/detik atau 15 bersamaan untuk IP + API key yang sama. Tunggu sesuai jumlah detik di Retry-After.

  • CMDMISSING_SCOPE

    API key tidak memiliki scope yang dibutuhkan perintah ini. Perintah lain dalam request tetap berjalan.

  • CMDINVALID_ARGS

    Argumen wajib tidak ada atau tidak valid: email, nilai field, opsi enum, key where, id list…

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.