API reference
Segment members
Check one customer, list a segment, or export it in bulk.
Check one customer's membership, list the people in a segment, or export a whole audience.
Check membership#
GET /v1/tenants/{tenant}/workspaces/{ws}/segments/{segment_id}/membership Workspace token
Is one customer in the segment right now?
Query
type string Identifier type, such as
email or phone.value string Identifier value.
curl "https://api.breeze.in/cdp/control-plane/v1/tenants/breeze/workspaces/my-store/segments/vip-customers/membership?type=email&[email protected]" \
-H "Authorization: Bearer $BREEZEIQ_TOKEN"{
"in_segment": true,
"since": "2026-10-08T10:15:04Z",
"profile_id": "60de1d6e-…",
"origin": "live-eval",
"evaluated_version": 3,
"as_of": "2026-10-08T11:02:10Z",
"segment_status": "active"
}An unknown identifier returns 200 with in_segment: false. An unknown segment returns 404.
List segment members#
GET /v1/tenants/{tenant}/workspaces/{ws}/segments/{segment_id}/members Workspace token
The people in a segment, with contacts and headline metrics.
Query
limit number Page size: 50 by default, up to 200.
cursor string next_cursor from the previous page.profile_type string Only members of this type, such as
customer.curl "https://api.breeze.in/cdp/control-plane/v1/tenants/breeze/workspaces/my-store/segments/vip-customers/members?limit=50" \
-H "Authorization: Bearer $BREEZEIQ_TOKEN"{
"segment_id": "vip-customers",
"members": [
{
"profile_id": "60de1d6e-…",
"profile_type": "customer",
"email": "[email protected]",
"phone": "+919812345678",
"total_spend": "12499",
"order_count": "3",
"last_order_at": "1791370287",
"entered_at": "2026-10-08T10:15:04Z"
}
],
"next_cursor": null,
"total_members": 3,
"segment_customers": 2,
"segment_visitors": 1,
"workspace_members": 11,
"workspace_customers": 7,
"workspace_visitors": 4
}Export segment members#
GET /v1/tenants/{tenant}/segments/{segment_id}/members Workspace token
Bulk export with profile ids only. Use it for syncing a whole audience.
Query
workspace_id string The segment's workspace.
cursor string next_cursor from the previous page.limit number Page size: 1,000 by default, up to 5,000.
curl "https://api.breeze.in/cdp/control-plane/v1/tenants/breeze/segments/vip-customers/members?workspace_id=my-store&limit=5000" \
-H "Authorization: Bearer $BREEZEIQ_TOKEN"{
"segment_id": "vip-customers",
"members": [
{
"profile_id": "60de1d6e-…",
"entered_at": "2026-10-08T10:15:04Z",
"origin": "live-eval"
}
],
"next_cursor": "03746e3b-…"
}