STstreet
Landlords

Get all Landlords

Changed on

This endpoint retrieves multiple paginated landlords along with meta and pagination information.

get/landlords

Request

Query parameters

filter[status]'current' | 'previous'

Filter by wether they are Current or Previous.

filter[property_status]string[]

Filter the Landlords by the Status of their Properties.

filter[address]string

Filter results by their address, this is a fuzzy wildcard match on the full address string.

filter[email_address]string email
Example:alice.walker@example.com

Filter results by an associated email address

filter[telephone_number]string

Filter results by an associated telephone number. The number must be in full international dialing format e.g. +441614960137

filter[trashed]'with' | 'only'

Optionally return result WITH deleted results or return ONLY deleted results.

filter[created_from]string date-time

Filter by results created after the provided date.

filter[created_to]string date-time

Filter by results created before the provided date.

filter[updated_from]string date-time

Filter by results updated after the provided date.

filter[updated_to]string date-time

Filter by results updated before the provided date.

includestring[]

Optional related entities to include in the results.

[
  "properties",
  "properties.branch",
  "notes"
]
page[size]number
Example:25

Set the number of results per page.

page[number]number
Example:3

Set the page number.

Response

OK.

Example response

{
  "data": [
    {
      "attributes": {
        "title": "Mrs",
        "first_name": "Jane",
        "last_name": "Doe",
        "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
          }
        },
        "telephone_numbers": [
          {
            "value": "+441632960911"
          }
        ],
        "email_addresses": [
          {
            "value": "john@johndoe.com"
          }
        ]
      },
      "relationships": {
        "properties": {
          "data": [
            {
              "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
            }
          ]
        },
        "notes": {
          "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
          }
        },
        "material_information": {
          "council_tax_band": "D"
        }
      },
      "relationships": {
        "branch": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        }
      }
    }
  ],
  "links": {
    "self": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=2",
    "first": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "next": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "prev": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=3",
    "last": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=9"
  },
  "meta": {
    "pagination": {
      "total": 226,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 23
    }
  }
}

Changes

  • b01c2825aba9Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • 6ed52b1e6e1eRevision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status