List addresses
Method
Path
addresses
Request Parameters
This operation accepts paging parameters.
Response
A JSON object with success
, message
, and data
attributes.
Results are paginated, and the paging
attribute holds information about the length of the data.
The data
attribute holds an array of Address objects.
Sample Response
{
"success": true,
"message": "Retrieved user addresses successfully",
"data": [
{
"id": 51,
"end_subscriber_type": "individual",
"company_name": null,
"first_name": "Max",
"last_name": "Mustermann",
"phone_number": null,
"email_address": "user@example.com",
"vat_number": null,
"street": "Wilhelmstraße",
"street_number": "123",
"residence": null,
"floor": null,
"box": null,
"postal_code": "12345",
"city": "Berlin",
"state": null,
"country": "DE",
"service_usage": null
},
{
"id": 52,
"end_subscriber_type": "individual",
"company_name": null,
"first_name": "Erika",
"last_name": "Mustermann",
"phone_number": null,
"email_address": "user2@example.com",
"vat_number": null,
"street": "Wilhelmstraße",
"street_number": "456",
"residence": null,
"floor": null,
"box": null,
"postal_code": "12346",
"city": "Berlin",
"state": null,
"country": "DE",
"service_usage": null
}
],
"paging": {
"total": 2,
"per_page": 25,
"page": 1
}
}