CDP REST APIAPI Reference
List Profile Aliases
List the external-id aliases linked to one of your brand's profiles.
GET /cdp/profiles/{id}/aliases lists the external-id aliases linked to one profile — the
raw ids you linked (email, Shopify customer id, …), with the internal tenant-key namespace
suffix stripped. Only aliases in your own scope are returned.
Every read is bound to your brand's shop scope. See Tenant Isolation & Scope.
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Path parameter ({id}) — the profile whose aliases you are listing. (Not a query parameter.) |
Response
The 200 response body:
| Field | Type | Description |
|---|---|---|
profileId | string | |
aliases | object[] | |
aliases[].aliasId | string | |
scope | string | Your brand's resolved shop domain. |
Errors
All errors share the standard envelope { "error": string, "error_description": string }.
| Status | Code | When |
|---|---|---|
401 | unauthorized | Missing or invalid API credential. |
403 | forbidden | No connected Shopify integration resolves a scope for the brand. |
404 | not_found | No such profile in your brand scope (missing or out-of-scope). |
405 | method_not_allowed | The request used a method other than GET. |
500 | internal_error | An unexpected error prevented the read. |