Kontak: list

Ambil list

Satu list dengan atribut dan penghitung langsung: anggota, anggota yang dapat dikirimi, dan anggota yang membuka atau mengklik.

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

Membutuhkan scope contact:read pada API key Anda.

Argumen

  • list_idstringwajib

    Id list.

    mis. "customers"

Mulai cepat

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

Respons

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

Field respons

  • stats.total

    Kontak di list.

  • stats.ok

    Kontak yang dapat dikirimi: berlangganan list dan berstatus subscribed.

  • stats.opened / clicked

    Anggota yang pernah membuka atau mengklik setidaknya sekali.

Penghitung bersifat langsung

Penghitung diperbarui setiap ada perubahan pada anggota, jadi membacanya tidak menelusuri list. List yang sedang dihapus menjawab NOT_FOUND.

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…

  • CMDNOT_FOUND

    Kontak, list, field, atau segmen tidak ada.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.