Skip to content

List Segments

GET /cdp/segments — list this brand’s segments, filtered to the authenticated scope. Another brand’s segments are never returned.

GET /cdp/segments
Authorization: Bearer vyg_…
{
"list": [
{
"id": "segment-scoped-id",
"name": "High-value customers",
"description": "Customers over $500 LTV",
"scope": "your-shop.myshopify.com"
}
],
"scope": "your-shop.myshopify.com"
}
FieldTypeDescription
listarrayThe brand’s segments. Each summary has id, name, optional description, and scope.
scopestringYour brand’s connected shop domain.

The owning-scope tag is an implementation detail and is not leaked in the summary.

Terminal window
curl -s "https://cdp.vyg.app/cdp/segments" \
-H "Authorization: Bearer vyg_your_key_here"
StatusWhen
401Missing or invalid credential.
403No connected shop resolves a scope.
405Unsupported method (use GET to list, POST to define).

See Errors for the full envelope.