Get all addresses

GET /api/v2/addresses

Personal access token & O auth2

This endpoint will return all addresses in the firm relevant to the user accessing them.

Headers

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.
filter[circle_uuids] string

Filter by a comma separated list of circle UUIDs.
include string

Comma separated list of relationships to include in the response. Valid relationships are [accounts, primary_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).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  address_1 string
  
  address_2 string
  
  address_3 string
  
  address_4 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  accounts object
  
  Hide accounts attributes Show accounts attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string
  
  primary_accounts object
  
  Hide primary_accounts attributes Show primary_accounts attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string
  
  moved_in_month integer
  
  moved_in_year integer
  
  moved_out_month integer
  
  moved_out_year integer
  
  residential_status string
  
  residential_status_other string
  
  lived_in_months integer

GET /api/v2/addresses

curl \
 --request GET 'https://api.plannrcrm.com/api/v2/addresses' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "Work Address",
      "uuid": "d942d173-c1bc-487d-8cb7-4f5ba452ca53",
      "county": "Hampshire",
      "country": "United Kingdom",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "3ccc9df6-ca10-4b51-a810-bc41f7fe93a7",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-06-26T11:37:11+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:11+01: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-06-26T11:37:11+01:00",
      "updated_at": "2025-06-26T11:37:11+01:00",
      "moved_in_year": 2022,
      "moved_in_month": 6,
      "moved_out_year": 2024,
      "lived_in_months": 19,
      "moved_out_month": 1,
      "primary_accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "7654ded6-4f43-4ec9-90e1-deb370658c62",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-06-26T11:37:11+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:11+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "residential_status": "homeowner",
      "residential_status_other": "homeowner"
    }
  ]
}