Skip to content

List Customer addresses

GET
/customers/{customerId}/address

Lists customer addresses.

Authorizations

BearerAuth
Type
HTTP (bearer)
Example"Bearer ..."

Parameters

Path Parameters

customerId*

External ID of the customerId

Type
string
Required

Query Parameters

limit
Type
number
Minimum
1
Maximum
100
offset
Type
number
Minimum
0

Responses

Successful operation

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": 0,
  
  
  
"street": "string",
  
  
  
"number": 0,
  
  
  
"complement": "string",
  
  
  
"zip_code": 0,
  
  
  
"neighborhood": "string",
  
  
  
"city": "string",
  
  
  
"state": "string",
  
  
  
"latitude": 0,
  
  
  
"longitude": 0,
  
  
  
"address_type": "string",
  
  
  
"name": "string",
  
  
  
"fk_id": "string"
  
  
}
  
],
  
"pagination": {
  
  
"page": 1,
  
  
"limit": 25,
  
  
"total": 100,
  
  
"totalPages": 4,
  
  
"hasNext": true,
  
  
"hasPrev": false,
  
  
"links": {
  
  
  
"self": "/orders?page=1&limit=25",
  
  
  
"first": "/orders?page=1&limit=25",
  
  
  
"last": "/orders?page=4&limit=25",
  
  
  
"next": "/orders?page=2&limit=25",
  
  
  
"prev": "string"
  
  
}
  
},
  
"meta": {
  
  
"timestamp": "2026-04-13T17:17:49",
  
  
"version": "1.0.0"
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI