CDP REST APIAPI Reference
List Segments
List this brand's segments — filtered to your scope, never another brand's.
GET /cdp/segments — list this brand's segments, filtered to the authenticated scope. Another
brand's segments are never returned.
Request
GET /cdp/segments
Authorization: Bearer vyg_…Response 200
{
"list": [
{
"id": "segment-scoped-id",
"name": "High-value customers",
"description": "Customers over $500 LTV",
"scope": "your-shop.myshopify.com"
}
],
"scope": "your-shop.myshopify.com"
}| Field | Type | Description |
|---|---|---|
list | array | The brand's segments. Each summary has id, name, optional description, and scope. |
scope | string | Your brand's connected shop domain. |
The owning-scope tag is an implementation detail and is not leaked in the summary.
Example
curl -s "https://cdp.vyg.app/cdp/segments" \
-H "Authorization: Bearer vyg_your_key_here"Errors
| Status | When |
|---|---|
401 | Missing or invalid credential. |
403 | No connected shop resolves a scope. |
405 | Unsupported method (use GET to list, POST to define). |
See Errors for the full envelope.