List A Person's Segments
customer_io.list_customer_segments
ActionCRM & salesconnection required
Calls the Customer.io API with the connection's credentials.
List every segment a person currently belongs to.
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
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
customer_id The value that identifies the person, of the kind named by 'id_type'. | string | Yes | — | — | ada@example.com |
id_type Which identifier 'customer_id' holds. Customer.io assumes 'id' when this is blank; 'email' and 'phone' work only where the workspace enables them as identifiers. | string | No | — | one of "id", "email", "cio_id", "phone" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"customer_id": "ada@example.com"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
segments One object per segment the person is in. | array | — |
segments[].id The segment's numeric id. | number | — |
segments[].name The segment name. | string | — |
segments[].description The segment description, if set. | string | — |
count How many segments the person is in. | number | — |
{
"count": 0,
"segments": [
{
"description": "",
"id": 0,
"name": ""
}
]
}See List A Person's Segments 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.