List Client Addresses
Retrieve addresses for a specific client.
GET
/client-address
Query Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
filter[client] |
string | Client ID to filter addresses | ?filter[client]=123 |
sort |
string | Sort field and direction | ?sort=-created |
Example Request
GET /api/v1.0/client-address?filter[client]=123
Response
{
"data": [
{
"id": "501",
"label": "Default address - US - 10001",
"client": "123",
"address": {
"country": "US",
"administrative_area": "NY",
"locality": "New York",
"postal_code": "10001",
"thoroughfare": "123 Main St",
"premise": "",
"name_line": "John Doe",
"first_name": "John",
"last_name": "Doe"
},
"address_types": [
{
"id": "billing",
"label": "Billing"
},
{
"id": "shipping",
"label": "Shipping"
}
],
"default_address": true,
"validated": true,
"rendered": "John Doe\n123 Main St\nNew York, NY 10001\nUnited States",
"created": "2025-10-01T10:00:00Z",
"updated": "2025-10-15T14:30:00Z"
}
],
"count": 1
}