Kontak: list

Daftar anggota

Telusuri anggota list berdasarkan urutan email, opsional hanya yang dapat dikirimi. Cara tercepat untuk mengekspor atau mengirim ke seluruh list.

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

Membutuhkan scope contact:read pada API key Anda.

Argumen

  • list_idstringwajib

    List-nya.

    mis. "customers"

  • sendable_onlybooleanopsional

    Hanya anggota yang berlangganan list dan berstatus subscribed. Difilter di server.

  • hydratebooleanopsional

    Menambahkan kontak lengkap ke setiap anggota. Menurunkan limit maksimum menjadi 1000.

  • limitnumberopsional

    Ukuran halaman, dari 1 sampai 5000 (1000 dengan hydrate). Default 100.

  • cursorstringopsional

    next_cursor dari halaman sebelumnya.

  • selectstring[]opsional

    Dengan hydrate, hanya kembalikan bagian ini dari setiap kontak, misalnya ["first_name", "fields.plan"]. email selalu dikembalikan.

Mulai cepat

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

Respons

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

Field respons

  • members[].email

    Email anggota.

  • members[].subscribed

    Berlangganan list ini.

  • members[].sendable

    Berlangganan list ini dan berstatus subscribed.

  • members[].added_at

    Kapan kontak bergabung dengan list.

  • members[].contact

    Kontaknya. Hanya dengan hydrate.

  • has_more / next_cursor

    Paginasi. Kirim next_cursor sebagai cursor untuk mendapatkan halaman berikutnya.

Dengan kontak lengkap

Dengan hydrate: true, setiap anggota juga membawa contact. Tambahkan select agar payload tetap kecil, misalnya hanya nama dan satu field yang Anda pakai di email.

Satu anggota dengan hydrate

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

List Members membaca satu list berdasarkan urutan email, secepat mungkin. Jika Anda juga memfilter berdasarkan tag, field, atau engagement, gunakan Query Contacts dengan list di where.

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.

  • CMDINVALID_CURSOR

    Cursor tidak valid atau milik query atau akun lain.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.