Get all addresses
This endpoint will return all addresses in the firm relevant to the user accessing them.
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[account_uuids] string
Filter by a comma separated list of account UUIDs.
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [accounts].
-
sort string
Field to sort by. Valid fields are [created_at, updated_at, address_1, postcode]. Negative sign to denote DESC. Defaults to '-created_at'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v2/addresses
curl \
-X GET https://api.plannrcrm.com/api/v2/addresses \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "Work Address",
"uuid": "9a227853-4db5-43c3-a361-526e7f8672ae",
"county": "Hampshire",
"country": "United Kingdom",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "95f07e00-be25-4c32-ac45-4e4888290f28",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-01-12T12:56:01+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-12T12:56:01+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"address_3": "The Innovative Centre",
"address_4": "Waterlooville",
"town_city": "Waterlooville",
"created_at": "2025-01-12T12:56:01+00:00",
"updated_at": "2025-01-12T12:56:01+00:00",
"moved_in_year": 2022,
"moved_in_month": 6,
"moved_out_year": 2024,
"lived_in_months": 19,
"moved_out_month": 1,
"residential_status": "homeowner",
"residential_status_other": "homeowner"
}
]
}