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.