Contacts: Lists

List Members

Walk the members of a list in email order, optionally only the ones you can send to. The fastest way to export or send to a whole list.

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

Needs the contact:read scope on your API key.

Arguments

  • list_idstringrequired

    The list.

    e.g. "customers"

  • sendable_onlybooleanoptional

    Only members subscribed to the list and with status subscribed. Filtered on the server.

  • hydratebooleanoptional

    Add the whole contact to each member. Lowers the maximum limit to 1000.

  • limitnumberoptional

    Page size, from 1 to 5000 (1000 with hydrate). Defaults to 100.

  • cursorstringoptional

    The next_cursor of the previous page.

  • selectstring[]optional

    With hydrate, return only these parts of each contact, for example ["first_name", "fields.plan"]. email always comes back.

Quick start

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

Response

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

Response fields

  • members[].email

    The member email.

  • members[].subscribed

    Subscribed to this list.

  • members[].sendable

    Subscribed to this list and with status subscribed.

  • members[].added_at

    When the contact joined the list.

  • members[].contact

    The contact. Only with hydrate.

  • has_more / next_cursor

    Pagination. Send next_cursor as cursor to get the next page.

With the whole contact

With hydrate: true, each member also brings contact. Add select to keep the payload small, for example only the name and a field you use in the email.

One hydrated member

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

List Members reads one list in email order, as fast as it gets. When you also filter by tag, field or engagement, use Query Contacts with list in the where.

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

  • 401INVALID_API_KEY

    The API key does not exist, was revoked or was disabled in the dashboard.

  • 429RATE_LIMITED

    More than 15 requests/s or 15 in flight for the same IP + API key. Wait the number of seconds in Retry-After.

  • CMDMISSING_SCOPE

    The API key does not have the scope this command needs. The other commands in the request still run.

  • CMDINVALID_ARGS

    A required argument is missing or invalid: email, field value, enum option, where key, list id…

  • CMDNOT_FOUND

    The contact, list, field or segment does not exist.

  • CMDINVALID_CURSOR

    The cursor is malformed or belongs to another query or account.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.