Get all account addresses
Headers
-
Content-Type string
-
Accept string
Query parameters
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [accounts].
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
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/v1/account/{account_uuid}/address
curl \
-X GET https://api.plannrcrm.com/api/v1/account/account_uuid/address \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Response examples (200)
{
"data": [
{
"name": "Work Address",
"uuid": "8d8c14fb-f431-408f-ba98-0ff641b062e3",
"county": "Hampshire",
"country": "United Kingdom",
"accounts": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "926a1a1b-01b1-4f9f-b8fd-61cc2dc7c360",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-11-20T13:23:59+00:00",
"first_name": "Gareth",
"updated_at": "2024-11-20T13:23:59+00:00",
"with_login": true,
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2024-11-20T13:23:59+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-11-20T13:23:59+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-11-20T13:23:59+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-11-20T13:23:59+00:00"
},
"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": "2024-11-20T13:23:59+00:00",
"updated_at": "2024-11-20T13:23:59+00:00",
"move_in_date": "2023-11-20"
}
]
}