Skip to main content
GET
/
api
/
v1
/
customer
/
addresses
List Addresses
curl --request GET \
  --url https://api.example.com/api/v1/customer/addresses
{
  "data": [
    {
      "customerAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "street": "<string>",
      "number": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "lat": 123,
      "lng": 123,
      "isDefault": true,
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

OK

data
object[]
required