STstreet
Interested Applicants

Get all Interested Applicants

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

get/interested-applicants

Request

Query parameters

includestring[]

Optional related entities to include in the results.

page[size]number
Example:25

Set the number of results per page.

page[number]number
Example:3

Set the page number.

filter[property]string

Filter by the property the interested applicants belong to (by property id)

Response

Get all Interested Applicants.

Example response

{
  "data": [
    {
      "relationships": {
        "applicant": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        },
        "property": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        }
      }
    }
  ],
  "included": [
    {
      "attributes": {
        "name": "Dave Smith & Helen Bloggs",
        "financial_position": "Agreement in Principle in place",
        "buying_position": "Property to sell",
        "requirements": {
          "property_type_preference": {
            "house": "Don't Mind",
            "flat": "Might Consider",
            "semi_detached": "Would Prefer"
          },
          "new_property_type_preference": {
            "house": "Don't Mind",
            "flat": "Might Consider",
            "semi_detached": "Would Prefer"
          },
          "areas": [
            "Ellesmere Park"
          ]
        }
      },
      "relationships": {
        "people": {
          "data": [
            {
              "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 226,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 23
    }
  }
}

Changes