v1

latestOpenAPI 3.0.02026-07-1427437.7 KB

Profiles

Get profile by version

Retrieves the information of a specific version of a client profile.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

For security and privacy reasons, this request returns masked profile data. For unmasked information, see Get unmasked profile by version.

Learn more about the Profile System and its other API endpoints.

get/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}

Path parameters

profileIdstring required

Example:70caf394-8534-447e-a0ca-1803c669c771

ID of the client's profile as returned by the Create profile endpoint's response, in the id field. It can also be an alternativeKey according to your custom profile schema. In this case, this request should also send the alternativeKey parameter.

profileVersionIdstring required

Example:70caf394-8534-447e-a0ca-1803c669c771

ID of the version of the client's profile as returned by endpoints that create or update profile information in the version field.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

{"stackTrail":"paths:/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}:get:responses:200:content:application/json:schema:items","oasType":"schema","type":"unknown"}