--- title: "Get profile by version" method: GET path: "/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}" tags: ["Profiles"] --- # Get profile by version `GET /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}` ## Request - Base URL: `https://apiexamples.vtexcommercestable.com.br` - URL: `https://apiexamples.vtexcommercestable.com.br/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}` - Auth: one of: - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken` - API key in header `VtexIdclientAutCookie` 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](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-/unmask). Learn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints. >⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions. > > This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | Profile System | Documents | **Get Item** | | Profile System | Documents | **Save and Update Item** | | Profile System | Documents | **Delete Item** | There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations. ## Path parameters - `profileId` string, required - `profileVersionId` string, required ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - object[]: Array containing masked profile information. - `id` string: ID of the client's profile. - `document` Profile: Profile schema. - `firstName` string, required: Client's first name. - `lastName` string, required: Client's last name. - `email` string, required: Client's email address. - `birthDate` string: Client's birth date in ISO 8601 format. - `document` string, required: Client's document. - `documentType` string, required: Type of document informed in `document`. - `{customField}` string: Name of custom field defined in [Create or delete custom fields](https://developers.vtex.com/docs/api-reference/profile-system#put-/api/storage/profile-system/schemas/profileSystem/custom). Can be of any type: string, number, boolean, array or object. - `meta` ProfileMeta: Profile metadata. - `version` string, required: Unique identifier of the profile version. - `author` string, required: Unique identifier of the user who created the profile. - `creationDate` string, required: Date when the profile was created in ISO 8601 format. - `lastUpdate` string, required: Date when the profile was last updated in ISO 8601 format. ## Changes - **2024-01-22** `7e244b9ee497`: 1 info - the response property `items/meta/lastUpdate` became required for the status `200` - **2023-11-01** `7688f96b7c96`: 1 breaking, 2 info - removed the required property `items/meta/lastUpdateDate` from the response with the `200` status - added the optional property `items/document/{customField}` to the response with the `200` status - added the optional property `items/meta/lastUpdate` to the response with the `200` status - **2023-10-31** `c68a1fb04e5a`: 2 warning, 1 info - removed the optional property `items/document/{customField}` from the response with the `200` status - removed the optional property `items/meta/lastUpdate` from the response with the `200` status - added the required property `items/meta/lastUpdateDate` to the response with the `200` status - **2023-10-26** `eb33b478ad52`: 1 breaking, 2 info - removed the required property `items/meta/lastUpdateDate` from the response with the `200` status - added the optional property `items/document/{customField}` to the response with the `200` status - added the optional property `items/meta/lastUpdate` to the response with the `200` status - …earlier changes not shown [Operation history](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture/changes/api/storage/profile-system/profiles/:profileId/versions/:profileVersionId/get.md) --- [API](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture.md) - [All operations](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/profile-system-pii-data-architecture/revisions/23729fa2a727?raw)