Users

Get a single User

This endpoint retrieves a single user by their UUID.

get/users/{user_id}

Request

Query parameters

includestring[]

Optional related entities to include in the results, e.g. branch,ownedProperties,applicants

Response

OK.

metaobject

Example response

{
  "data": {
    "relationships": {
      "properties": {
        "data": [
          {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      }
    }
  },
  "included": [
    {
      "attributes": {
        "address": {
          "single_line": "19 Lansdowne Road, Monton, Manchester",
          "anon_single_line": "Lansdowne Road, Monton, Manchester",
          "building_number": "19",
          "line_1": "19 Lansdowne Road",
          "line_2": "Monton",
          "line_3": "Manchester",
          "town": "Manchester",
          "country": "United Kingdom",
          "postcode": "M30 9PA",
          "udprn": "28327204",
          "geo": {
            "lat": 0.2365698,
            "lng": 53.023654
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.