---
title: "Get address by ID"
method: GET
path: "/api/dataentities/AD/documents/{addressId}"
tags: ["Addresses"]
---

# Get address by ID

`GET /api/dataentities/AD/documents/{addressId}`

This endpoint retrieves information of a specific address by its unique identifier.

## 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** |
| --------------- | ----------------- | ----------------- |
| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |
| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |

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

- `addressId` string, required

## Query parameters

- `_fields` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- AddressResponse — Response body for an address document.
  - `addressLabel` string, nullable — A user-defined label to identify the address.
  - `addressType` 'commercial' | 'invoice', nullable — The type of address: `commercial` for shipping, `invoice` for billing.
  - `city` string, nullable — The city of the address.
  - `complement` string, nullable — Any additional information for the address (e.g., apartment, floor).
  - `country` string, nullable — The country of the address in three-letter code format (e.g., `"USA"`).
  - `countryfake` string, nullable — Placeholder or optional country value.
  - `geoCoordinate` string, nullable — Geographical coordinates of the address (latitude and longitude).
  - `neighborhood` string, nullable — The neighborhood of the address.
  - `number` string, nullable — The street number of the address.
  - `postalCode` string, nullable — The postal code of the address. The format must be compatible with the address country postal code format. (e.g., `00000` for addresses in the USA).
  - `receiverName` string, nullable — The name of the person or entity receiving at this address.
  - `reference` string, nullable — Optional reference point or landmark near the address.
  - `state` string, nullable — The state or province of the address.
  - `street` string, nullable — The street name of the address.
  - `userId` string, nullable — The ID of the user or related entity.
  - `id` string, nullable — Unique identifier for this address record.
  - `accountId` string, nullable — ID of the account related to this address.
  - `accountName` string, nullable — Name of the account related to this address.
  - `dataEntityId` string, nullable — ID of the data entity this address belongs to (always `"AD"`).
  - `createdBy` string, nullable — ID of the user who created the address record.
  - `createdIn` string, nullable — Timestamp of when the address record was created.
  - `updatedBy` string, nullable — ID of the user who last updated the address record.
  - `updatedIn` string, nullable — Timestamp of the last update to the address record.
  - `lastInteractionBy` string, nullable — ID of the user who had the last interaction with the record.
  - `lastInteractionIn` string, nullable — Timestamp of the last interaction with the record.
  - `followers` string[], nullable — List of users following this address record.
  - `tags` string[], nullable — List of tags associated with this address.
  - `auto_filter` string, nullable — Optional field used for automatic filtering or categorization.

---

[API](https://skmtc.net/vtex/apis/master-data-api-v1.md) · [All operations](https://skmtc.net/vtex/apis/master-data-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/master-data-api-v1/revisions/a90298d4afb1/schema)