List Segments
GET /cdp/segments — list this brand’s segments, filtered to the authenticated scope. Another
brand’s segments are never returned.
Request
Section titled “Request”GET /cdp/segmentsAuthorization: Bearer vyg_…Response 200
Section titled “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
Section titled “Example”curl -s "https://cdp.vyg.app/cdp/segments" \ -H "Authorization: Bearer vyg_your_key_here"Errors
Section titled “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.