Search Users

Search Agent records using field filters and free-text search.

Filtering & lookups

Any field listed below can be filtered on directly for an exact match (e.g. ?status=active), or suffixed with __<lookup> to use a Django-style lookup appropriate to that field's type (e.g. ?created__gte=2024-01-01). Only lookups valid for a given field's type are accepted; see that field's own description for the ones it supports.

| Lookup | Meaning | | --- | --- | | startswith / istartswith | Value starts with the given string (istartswith case-insensitive). | | endswith / iendswith | Value ends with the given string (iendswith case-insensitive). | | in | Value is one of a comma-separated list, e.g. ?id__in=1,2,3. | | gt / gte | Greater than / greater than or equal to. | | lt / lte | Less than / less than or equal to. | | range | Value falls between two comma-separated bounds, e.g. ?price__range=100,200. | | isnull | Field is/isn't null. Pass true or false. | | date | Matches the date part of a datetime field, e.g. ?created__date=2024-01-01. | | year / iso_year | Matches the (ISO) year of a date/datetime field. | | quarter | Matches the quarter (1-4) of a date/datetime field. | | month | Matches the month (1-12) of a date/datetime field. | | week / week_day | Matches the ISO week number, or day of the week (1=Sunday...7=Saturday). | | day | Matches the day of the month (1-31). | | time | Matches the time part of a datetime field. | | hour / minute / second | Matches that component of a time/datetime field. | | contained_by | Array/JSON field is fully contained within the given comma-separated values. | | overlap | Array field shares at least one element with the given comma-separated values. | | len | Matches the number of elements in an array field. | | has_key | JSON field contains the given top-level key. | | has_keys | JSON field contains all of the given comma-separated top-level keys. | | has_any_keys | JSON field contains at least one of the given comma-separated top-level keys. |

Combinator suffixes can be appended instead of (or in addition to) a lookup to control how a filter combines with the others on the request:

| Combinator | Meaning | | --- | --- | | or | Match this filter optionally — OR'd with the other filters instead of required. | | not | Exclude records matching this filter. | | ornot | Exclude records matching this filter, optionally (OR'd with other exclusions). | | and | Explicitly require this filter alongside the others (the default behaviour). |

HTTP Request

POST/users/api/v1/agents/search/

Example Response

{
  "count": 0,
  "next": "http://www.example.com",
  "previous": "http://www.example.com",
  "results": [
    {
      "application_accepted": false,
      "application_expired": false,
      "application_declined": false,
      "application_submitted": false,
      "deal_notify_sale_new": false,
      "deal_notify_sale_final": false,
      "deal_notify_sale_closed": false,
      "deal_notify_sale_cancelled": false,
      "deal_notify_sale_activities_expired": false,
      "lead_new": false,
      "listing_mandate_expiry": false,
      "listing_property_updated": false,
      "referral_new": false,
      "referral_update": false,
      "referral_transaction": false,
      "valuation_new": false,
      "valuation_approved": false,
      "valuation_published": false
    }
  ]
}

NameDescription

search

string

Free-text search across the model's configured search fields

fields

string

Comma-separated list of fields to match the search/trigram query against

id

string

Filter results by exact id. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

agent

string

Filter results by exact agent. Also accepts any `agent__<lookup>` suffix (e.g. `agent__in`).

active

string

Filter results by exact active. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

full_name

string

Filter results by exact full_name. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

portals

string

Filter results by exact portals. Also accepts any `portals__<lookup>` suffix (e.g. `portals__in`).

designation

string

Filter results by exact designation. Also accepts any `designation__<lookup>` suffix (e.g. `designation__in`).

notification_preferences

string

Filter results by exact notification_preferences. Also accepts any `notification_preferences__<lookup>` suffix (e.g. `notification_preferences__in`).

testimonials

string

Filter results by exact testimonials. Also accepts any `testimonials__<lookup>` suffix (e.g. `testimonials__in`).

qualifications

string

Filter results by exact qualifications. Also accepts any `qualifications__<lookup>` suffix (e.g. `qualifications__in`).

employment_history

string

Filter results by exact employment_history. Also accepts any `employment_history__<lookup>` suffix (e.g. `employment_history__in`).

awards

string

Filter results by exact awards. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__has_any_keys`, `__has_key`, `__has_keys`, `__iendswith`, `__in`, `__isnone`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

vehicles

string

Filter results by exact vehicles. Also accepts any `vehicles__<lookup>` suffix (e.g. `vehicles__in`).

meta

string

Filter results by exact meta. **Allowed lookups:** `__or`, `__not`, `__ornot`

created

string

Filter results by exact created. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__date`, `__day`, `__endswith`, `__gt`, `__gte`, `__hour`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__minute`, `__month`, `__quarter`, `__range`, `__second`, `__startswith`, `__time`, `__week`, `__week_day`, `__year`

modified

string

Filter results by exact modified. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__date`, `__day`, `__endswith`, `__gt`, `__gte`, `__hour`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__minute`, `__month`, `__quarter`, `__range`, `__second`, `__startswith`, `__time`, `__week`, `__week_day`, `__year`

deleted

string

Filter results by exact deleted. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__date`, `__day`, `__endswith`, `__gt`, `__gte`, `__hour`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__minute`, `__month`, `__quarter`, `__range`, `__second`, `__startswith`, `__time`, `__week`, `__week_day`, `__year`

uuid

string

Filter results by exact uuid. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

source_ref

string

Filter results by exact source_ref. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

title

string

Filter results by exact title. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

first_name

string

Filter results by exact first_name. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

last_name

string

Filter results by exact last_name. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

preferred_name

string

Filter results by exact preferred_name. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

full_name_slug

string

Filter results by exact full_name_slug. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

email

string

Filter results by exact email. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

id_number

string

Filter results by exact id_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

gender

string

Filter results by exact gender. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

user_website

string

Filter results by exact user_website. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

country_code

string

Filter results by exact country_code. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

cell_number

string

Filter results by exact cell_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

whatsapp_number

string

Filter results by exact whatsapp_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

resume

string

Filter results by exact resume. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

resignation_date

string

Filter results by exact resignation_date. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__day`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__month`, `__quarter`, `__range`, `__startswith`, `__week`, `__week_day`, `__year`

privy_seal_id

string

Filter results by exact privy_seal_id. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

ooba_obi_tracking_code

string

Filter results by exact ooba_obi_tracking_code. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

website_url

string

Filter results by exact website_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

blog_url

string

Filter results by exact blog_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_url

string

Filter results by exact facebook_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

twitter_url

string

Filter results by exact twitter_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

linkedin_url

string

Filter results by exact linkedin_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

youtube_url

string

Filter results by exact youtube_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

pinterest_url

string

Filter results by exact pinterest_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

google_my_business_url

string

Filter results by exact google_my_business_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

instagram_url

string

Filter results by exact instagram_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

vimeo_url

string

Filter results by exact vimeo_url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

physical_address

string

Filter results by exact physical_address. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

postal_address

string

Filter results by exact postal_address. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

home_number

string

Filter results by exact home_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

income_tax_ref_number

string

Filter results by exact income_tax_ref_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

fidelity_fund_number

string

Filter results by exact fidelity_fund_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

fidelity_fund_certificate_status

string

Filter results by exact fidelity_fund_certificate_status. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

affairs_board_exam

string

Filter results by exact affairs_board_exam. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

bank

string

Filter results by exact bank. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

account_holder

string

Filter results by exact account_holder. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

account_number

string

Filter results by exact account_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

bank_branch

string

Filter results by exact bank_branch. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

bank_branch_code

string

Filter results by exact bank_branch_code. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

account_type

string

Filter results by exact account_type. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

tax_name_of_firm

string

Filter results by exact tax_name_of_firm. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

tax_consultant_name

string

Filter results by exact tax_consultant_name. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

tax_physical_address

string

Filter results by exact tax_physical_address. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

tax_postal_address

string

Filter results by exact tax_postal_address. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

tax_office_number

string

Filter results by exact tax_office_number. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

tax_fax

string

Filter results by exact tax_fax. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

tax_email_address

string

Filter results by exact tax_email_address. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_verification_key

string

Filter results by exact facebook_verification_key. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_tracking_keys

string

Filter results by exact facebook_tracking_keys. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

adwords_tracking_keys

string

Filter results by exact adwords_tracking_keys. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

linkedin_tracking_keys

string

Filter results by exact linkedin_tracking_keys. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

feed_facebook_listings

string

Filter results by exact feed_facebook_listings. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

feed_facebook_news

string

Filter results by exact feed_facebook_news. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_app_id

string

Filter results by exact facebook_app_id. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_app_secret

string

Filter results by exact facebook_app_secret. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_profile_id

string

Filter results by exact facebook_profile_id. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_oauth_access_token

string

Filter results by exact facebook_oauth_access_token. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

facebook_page_token

string

Filter results by exact facebook_page_token. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

profile_picture_coord_x

string

Filter results by exact profile_picture_coord_x. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

profile_picture_coord_y

string

Filter results by exact profile_picture_coord_y. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

profile_picture_width

string

Filter results by exact profile_picture_width. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

profile_picture_height

string

Filter results by exact profile_picture_height. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

commencement_date

string

Filter results by exact commencement_date. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__day`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__month`, `__quarter`, `__range`, `__startswith`, `__week`, `__week_day`, `__year`

image

string

Filter results by exact image. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

signature_image

string

Filter results by exact signature_image. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

signature_image_coord_x

string

Filter results by exact signature_image_coord_x. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

signature_image_coord_y

string

Filter results by exact signature_image_coord_y. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

signature_image_width

string

Filter results by exact signature_image_width. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

signature_image_height

string

Filter results by exact signature_image_height. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

fidelity_fund_certificate

string

Filter results by exact fidelity_fund_certificate. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

documents

string

Filter results by exact documents. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

branches

string

Filter results by exact branches. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

display_on_branches

string

Filter results by exact display_on_branches. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

activate_account_hash

string

Filter results by exact activate_account_hash. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

activate_account_expires

string

Filter results by exact activate_account_expires. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__date`, `__day`, `__endswith`, `__gt`, `__gte`, `__hour`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__minute`, `__month`, `__quarter`, `__range`, `__second`, `__startswith`, `__time`, `__week`, `__week_day`, `__year`

account_activated

string

Filter results by exact account_activated. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

last_activation_hash

string

Filter results by exact last_activation_hash. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

activated_at

string

Filter results by exact activated_at. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__date`, `__day`, `__endswith`, `__gt`, `__gte`, `__hour`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__minute`, `__month`, `__quarter`, `__range`, `__second`, `__startswith`, `__time`, `__week`, `__week_day`, `__year`

serviced_suburbs

string

Filter results by exact serviced_suburbs. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

serviced_areas

string

Filter results by exact serviced_areas. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

serviced_listing_types

string

Filter results by exact serviced_listing_types. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

serviced_property_types

string

Filter results by exact serviced_property_types. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

serviced_property_zoning

string

Filter results by exact serviced_property_zoning. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

birthday_date

string

Filter results by exact birthday_date. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__day`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__month`, `__quarter`, `__range`, `__startswith`, `__week`, `__week_day`, `__year`

private_documents

string

Filter results by exact private_documents. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`

target_type

string

Filter results by exact target_type. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

number_of_people_canvassed

string

Filter results by exact number_of_people_canvassed. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

number_of_valuations

string

Filter results by exact number_of_valuations. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

mandates_created

string

Filter results by exact mandates_created. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

sole_mandates_created

string

Filter results by exact sole_mandates_created. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

property_matches_sent

string

Filter results by exact property_matches_sent. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

viewings

string

Filter results by exact viewings. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

show_houses

string

Filter results by exact show_houses. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

feedback_requests_sent

string

Filter results by exact feedback_requests_sent. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

listings_sold

string

Filter results by exact listings_sold. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

listings_created

string

Filter results by exact listings_created. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

listings_sold_value

string

Filter results by exact listings_sold_value. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

monthly_net_commission

string

Filter results by exact monthly_net_commission. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

commission_split

string

Filter results by exact commission_split. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

bond_commission_split

string

Filter results by exact bond_commission_split. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

deduct_franchise_fee

string

Filter results by exact deduct_franchise_fee. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

nqf_level

string

Filter results by exact nqf_level. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

pde_level

string

Filter results by exact pde_level. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

training_payment_option

string

Filter results by exact training_payment_option. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`

training_payment_date

string

Filter results by exact training_payment_date. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__day`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__iso_week_day`, `__iso_year`, `__istartswith`, `__lt`, `__lte`, `__month`, `__quarter`, `__range`, `__startswith`, `__week`, `__week_day`, `__year`

default_home_page

string

Filter results by exact default_home_page. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`

statistics

string

Filter results by exact statistics. Also accepts any `statistics__<lookup>` suffix (e.g. `statistics__in`).

group

string

Filter results by exact group. Also accepts any `group__<lookup>` suffix (e.g. `group__in`).

race

string

Filter results by exact race. Also accepts any `race__<lookup>` suffix (e.g. `race__in`).

user

string

Filter results by exact user. Also accepts any `user__<lookup>` suffix (e.g. `user__in`).

pending_user

string

Filter results by exact pending_user. Also accepts any `pending_user__<lookup>` suffix (e.g. `pending_user__in`).

schedule

string

Filter results by exact schedule. Also accepts any `schedule__<lookup>` suffix (e.g. `schedule__in`).

Responses

200
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active