Addresses

Get client addresses

Retrieves information of all addresses of a given client, by its profileId.

For security and privacy reasons, this request returns masked address data. For unmasked information, see Get unmasked client addresses.

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

⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plus, which is in closed beta phase, only available in select regions.

This feature is part of VTEX Shield. If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact Commercial Support. Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our contact form.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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 for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/storage/profile-system/profiles/{profileId}/addresses

Path parameters

profileIdstring required

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

There are two value options for this field:

ID of the client's profile, as in the id field returned by the Create profile endpoint.
The value of an alternative key (email or document). When using this option, the alternativeKey query parameter is required, to inform which key is being used.

Query parameters

alternativeKey'email' | 'document'

Example:email

When using an alternative key as profileId value, fill this parameter with the key you wish to use as profileId. There are two possible values: email and document.

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

idstring

ID of a client's address.

Example response

[
  {
    "document": {
      "postalCode": "20200-000",
      "countryName": "Brasil",
      "countryCode": "BR",
      "administrativeAreaLevel1": "RJ",
      "locality": "Locality",
      "localityAreaLevel1": "locality area",
      "route": "51",
      "streetNumber": "999",
      "profileId": "70caf394-8534-447e-a0ca-1803c669c771",
      "contactId": "1"
    }
  }
]

Changes

Changed in 4 of the 50 revisions of this API.36

Nov 22, 2024e27de7bcbf6012See the full diff
- ▲
  the query request parameter alternativeKey was restricted to a list of enum values
  request-parameter-became-enum
- ○
  added the new enum value document to the query request parameter alternativeKey
  request-parameter-enum-value-added
- ○
  added the new enum value email to the query request parameter alternativeKey
  request-parameter-enum-value-added
Nov 21, 2023daeb92023d451See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Oct 20, 202375d99bccaed61See the full diff
- ▲
  the // response's property type changed from no type to string for status
  response-property-type-changed
Oct 18, 2023f18d811082f513See the full diff
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history