Quickstart
Get an API key and make your first CDP API request.
This guide gets you from zero to your first GET /cdp/profiles response.
1. Get an API key
-
Self-serve (recommended). Issue a key from the web-client settings page. A key is minted off your
brand_id → connected shopresolution, so any brand already connected to a Shopify shop can be issued a key with no new app install. -
Staff-issued. A Voyage staff member can issue a key for your brand on request.
Either way you receive a token of the form vyg_…. It is shown exactly once — store it
in a secret manager immediately. Subsequent reads only ever return the key prefix, never
the plaintext.
Issuing, rotating, and revoking keys uses a session credential, not an API key — an API key can never manage keys (see Authentication).
2. Make your first request
Reads authenticate with the key as a Bearer token:
curl -s https://cdp.vyg.app/cdp/profiles \
-H "Authorization: Bearer vyg_your_key_here"A successful response is the pagination envelope:
{
"bucket": "customers",
"list": [],
"identities": {},
"totalSize": 0,
"offset": 0,
"pageSize": 25,
"scope": "your-shop.myshopify.com",
"nextCursor": null
}The scope field is your brand's connected shop domain — every row in list is bound to
it. From here:
- Filter the bucket:
?bucket=customers(default, deterministic identities) or?bucket=anonymous(pixel-only profiles). - Search:
?q=<term>. - Page:
?limit=(default 25, max 100) and?offset=, or follownextCursorfor deep enumeration. See Pagination.
3. Explore
- List Profiles — the endpoint you just called, in full.
- Authentication — credential classes and scope.
- Errors — the error envelope and status codes.