List the addresses of a record

Returns the addresses stored in one address field of a record, in their display order, 10 per page by default. Address fields are form fields of type address. Custom address fields are listed by GET /fields?item_type=...; the built-in contact Address field (handle address) is not, because it has no dbcolumn. Find its ID in Settings > Fields, where its variable name is ${field_<id>}.

The response is a plain page object without the success envelope: the addresses are in data, and the pagination fields (current_page, last_page, next_page_url, ...) sit next to it.

Responses

🟢200OK

application/json

A page of addresses. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "current_page": 1,
    "data": [
        {
            "id": 311,
            "item_type": "contacts",
            "item_id": 4821,
            "field_id": 45,
            "street": "Main St",
            "housenumber": "120",
            "street2": "Suite 4",
            "suburb": null,
            "city": "Miami",
            "zip": "33101",
            "state": "FL",
            "country": "US",
            "type": null,
            "note": null,
            "order": 0,
            "country_label": "United States"
        }
    ],
    "first_page_url": "https://api.hqrentals.app/api/fields/addresses?item_type=contacts&page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.hqrentals.app/api/fields/addresses?item_type=contacts&page=1",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "active": false
        },
        {
            "url": "https://api.hqrentals.app/api/fields/addresses?item_type=contacts&page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Next &raquo;",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://api.hqrentals.app/api/fields/addresses",
    "per_page": 10,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}

🟠422Parameter Error

Request

Responses