v1

latestOpenAPI 3.1.02026-08-0480204704.7 KB

Applicants

Get all Lettings Applicants

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

get/lettings-applicants

filter[branch]string uuid

Example:a7c052ea-316a-4b55-8d47-9af7f782f887

Filter the Applicants by Branch.

filter[areas]string[]

Filter the Applicants by a comma-separated list of area names.

filter[price_from]integer

Filter results by their minimum budget.

filter[price_to]integer

Filter results by their maximum budget.

filter[min_bedrooms]integer

Filter results by the minimum number of bedrooms they require

filter[furnished]boolean

Filter results by wether or not the require furnished properties.

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.

filter[trashed]'with' | 'only'

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

includestring[]

Optional related entities to include in the results, e.g. branch,offers,viewings,people,notes

page[size]number

Example:25

Set the number of results per page.

page[number]number

Example:3

Set the page number.

filter[follow_ups_due_from]string date

Filter results to applicants with a follow up after the provided ISO8601 date.

filter[follow_ups_due_to]string date

Filter results to applicants with a follow up before the provided ISO8601 date.

filter[lead_rating]string[]

Filter applicants by their lead rating. Accepts: hot, warm, cold, or null. Can pass multiple values.

Get one or more Lettings Applicants in a paginated result.