Segment Members

GET /cdp/segments/{id}/members — read a segment’s membership. The brand must own the segment; only in-scope profiles are returned, with a capped page size.

Request

GET /cdp/segments/{id}/members
Authorization: Bearer vyg_…

Path parameters

Param	Type	Description
id	string	The segment id.

Query parameters

Param	Type	Default	Description
limit	integer	25	Page size, clamped to a maximum of 100.
offset	integer	0	Offset; offset + limit must stay within the 10,000-row window.
sort	string	—	Sort key.

Response 200

{
  "segmentId": "segment-scoped-id",
  "list": [{ "itemId": "shopify_your-shop_1234", "properties": {} }],
  "identities": {
    "shopify_your-shop_1234": {}
  },
  "totalSize": 1,
  "offset": 0,
  "pageSize": 25,
  "scope": "your-shop.myshopify.com"
}

Field	Type	Description
segmentId	string	The segment id you requested.
list	array	The page of member profiles (only in-scope profiles).
identities	object	Identity projection keyed by each profile’s itemId.
totalSize	integer	Estimated total, capped at 10,000.
offset	integer	Offset this page started at.
pageSize	integer	Effective page size.
scope	string	Your brand’s connected shop domain.

Example

curl -s "https://cdp.vyg.app/cdp/segments/segment-scoped-id/members?limit=25" \
  -H "Authorization: Bearer vyg_your_key_here"

Errors

Status	When
400	Missing segment id, or a deep offset past the result window.
401	Missing or invalid credential.
403	No connected shop resolves a scope.
405	Unsupported method (use GET).

See Errors for the full envelope.