Book a demo

List Segment Members

customer_io.list_segment_members
ActionCRM & salesconnection required

Calls the Customer.io API with the connection's credentials.

Page through the people in a segment, returning an identifier object for each one.

Ask about Customer.ioAll Customer.io nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Customer.io
Secret shape
{"site_id": "…", "api_key": "…", "app_api_key": "…"} — the Site ID and Track API key for the Track nodes, the App API key for the rest
Config it needs
region, workspace_id
Resolved by
config.connection_id, else node.connection_id

Configuration

3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
segment_id
The numeric id of the segment, from its page in the dashboard under Usage.
stringYes——12
limit
How many people to return per page. Customer.io defaults to 1000 and caps this at 30000.
numberNo—1–30000—
start
The paging token to continue from: the 'next' value a previous page returned.
stringNo———

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "segment_id": "12"
}

Output

One shape.

result

FieldTypeExample
identifiers
One object per person, carrying id, email and cio_id.
array—
identifiers[].id
The person's own id, empty where they have none.
string—
identifiers[].email
The person's email address.
string—
identifiers[].cio_id
Customer.io's internal id for the person.
string—
ids
The same people as bare id strings; empty when none were returned.
array—
count
How many people this page carries.
number—
next
The paging token for the next page; empty on the last one.
string—
segment_id
The segment the page was read from.
number—
{
  "count": 0,
  "identifiers": [
    {
      "cio_id": "",
      "email": "",
      "id": ""
    }
  ],
  "ids": [],
  "next": "",
  "segment_id": 0
}

Related Customer.io nodes

See List Segment Members run in a workflow.

In a technical demo we add the Customer.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales