Sign in

v1

latestOpenAPI 3.1.02026-08-0480204704.7 KB
Applicants

Get all Sales Applicants

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

get/sales-applicants

Query parameters

filter[branch]string uuid

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[buying_position]string[]

Filter the Applicants by their buying position.

Available values are:

  • FTB (First-time buyer)
  • INV (Investor)
  • BTLI (Buy to let investor)
  • NPTS (No property to sell)
  • NOM (In process of selling - Valuation)
  • OTM (In process of selling - On the market)
  • SSTC (In process of selling - Sold STC)
  • UO (In process of selling - Under Offer)
  • PTS (Property to sell)
  • DEV (Developer)
  • BUY (Buying Agent)
filter[financial_position]string[]

Filter the Applicants by their financial position.

Available values are:

  • NIP (Nothing in place)
  • SOAQ (Seeking own advice / quotes)
  • SAMA (Currently seeing agent’s mortgage advisor)
  • AIP (Agreement in Principle in place)
  • NFCB (Does not need Finance (Cash Buyer))
  • CBFS (Cash Buyer, proceeds from Sale)
  • PMTG (Porting Mortgage)
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, e.g. branch,offers,viewings,people,notes,sales

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.

Response

OK.