Get an address

GET /api/v2/addresses/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  The friendly name for the address.
- address_1 string
  
  The first line of the address.
- address_2 string
  
  The second line of the address.
- address_3 string
  
  The third line of the address.
- address_4 string
  
  The fourth line of the address.
- town_city string
  
  The town or city.
- county string
  
  The county.
- postcode string
  
  The postcode.
- country string
  
  The country.
- accounts object
  
  The accounts who own the address. This may not be included when viewing all addresses. Refer to the documentation to include this field.
  
  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
  
  The accounts who own the address and have it as their primary address. This may not be included when viewing all addresses. Refer to the documentation to include this field.
  
  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
  
  The month the client moved into this address.
- moved_in_year integer
  
  The year the client moved into this address.
- moved_out_month integer
  
  The month the client moved out of this address.
- moved_out_year integer
  
  The year the client moved out of this address.
- residential_status string
  
  The client's residential status when living at the address.
- residential_status_other string
  
  The client's residential status if it is not provided in the residential_status options. Must only be provided if residential_status is other.
- lived_in_months integer
  
  The number of months the client lived in the address.

GET /api/v2/addresses/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v2/addresses/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "name": "Work Address",
  "uuid": "f6324459-8d46-46fd-ae43-fce43096b0e3",
  "county": "Hampshire",
  "country": "United Kingdom",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "cc5f95ce-34c2-4a65-bda5-9502e4bb60c5",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-09-17T15:46:53+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-09-17T15:46:53+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-09-17T15:46:53+01:00",
  "updated_at": "2025-09-17T15:46:53+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": "215f7354-4c2c-483f-81da-988b2612cbfa",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-09-17T15:46:53+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-09-17T15:46:53+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "residential_status": "homeowner",
  "residential_status_other": "homeowner"
}