List Branches

List all Branch records.

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

GET/branches/api/v1/branches/

Example Response

{
  "count": 0,
  "next": "http://www.example.com",
  "previous": "http://www.example.com",
  "results": [
    {
      "id": 0,
      "site": 0,
      "archive_branch_action": null,
      "portals": [],
      "review_providers": [],
      "testimonials": [],
      "franchises": [],
      "meta": {},
      "created": "2026-09-08T14:40:50.571Z",
      "modified": "2026-09-08T14:40:50.571Z",
      "deleted": "2026-09-08T14:40:50.571Z",
      "source_ref": "string",
      "eos3_id": -2147483648,
      "display": false,
      "active": false,
      "uuid": "string",
      "lightstone_api_key": "string",
      "openai_api_key": "string",
      "name": "string",
      "country_code": "string",
      "telephone_number": "string",
      "fax_number": "string",
      "cell_number": "string",
      "email": "user@example.com",
      "physical_address": "string",
      "postal_address": "string",
      "head_office": false,
      "branch_profile": "string",
      "enable_display_currency": false,
      "display_currency": "string",
      "convert_listing_price": false,
      "bank": "string",
      "account_holder": "string",
      "account_number": "string",
      "bank_branch": "string",
      "bank_branch_code": "string",
      "account_type": "string",
      "blog_url": "http://www.example.com",
      "website_url": "string",
      "facebook_url": "http://www.example.com",
      "twitter_url": "http://www.example.com",
      "linkedin_url": "http://www.example.com",
      "youtube_url": "http://www.example.com",
      "pinterest_url": "http://www.example.com",
      "google_my_business_url": "http://www.example.com",
      "ooba_obi_tracking_code": "string",
      "instagram_url": "http://www.example.com",
      "vimeo_url": "http://www.example.com",
      "map_x_position": "string",
      "map_y_position": "string",
      "facebook_app_id": "string",
      "facebook_app_secret": "string",
      "facebook_profile_id": "string",
      "fb_oauth_access_token": "string",
      "fb_page_token": "string",
      "feed_facebook_listings": false,
      "feed_facebook_news": false,
      "branch_managers": [],
      "branch_franchisees": [],
      "agent_of_the_month": -2147483648,
      "leads_manager": -2147483648,
      "referrals_managers": [],
      "distressed_sales_coordinator": -2147483648,
      "facebook_tracking_keys": [],
      "adwords_tracking_keys": [],
      "location": -2147483648,
      "images": [],
      "documents": [],
      "serviced_suburbs": [],
      "serviced_areas": [],
      "serviced_listing_types": [],
      "map_image": -2147483648,
      "awards": null,
      "facebook_verification_key": "string",
      "linkedin_tracking_keys": [],
      "target_type": "string",
      "number_of_people_canvassed": -2147483648,
      "number_of_valuations": -2147483648,
      "mandates_created": -2147483648,
      "listings_created": -2147483648,
      "listings_sold": -2147483648,
      "listings_sold_value": "0.00",
      "google_business_account_id": "string",
      "referral_intra_branch": false,
      "statistics": 0,
      "partners": []
    }
  ]
}

Name	Description
order_by	string Which field to use when ordering the results.
offset	integer Offset for Pagination
limit	integer Page Size
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`
portals	string Filter results by exact portals. Also accepts any `portals__<lookup>` suffix (e.g. `portals__in`).
review_providers	string Filter results by exact review_providers. Also accepts any `review_providers__<lookup>` suffix (e.g. `review_providers__in`).
testimonials	string Filter results by exact testimonials. Also accepts any `testimonials__<lookup>` suffix (e.g. `testimonials__in`).
franchises	string Filter results by exact franchises. Also accepts any `franchises__<lookup>` suffix (e.g. `franchises__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`
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`
eos3_id	string Filter results by exact eos3_id. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
display	string Filter results by exact display. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
active	string Filter results by exact active. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
uuid	string Filter results by exact uuid. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`
lightstone_api_key	string Filter results by exact lightstone_api_key. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`
openai_api_key	string Filter results by exact openai_api_key. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`
name	string Filter results by exact name. 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`
telephone_number	string Filter results by exact telephone_number. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`
fax_number	string Filter results by exact fax_number. 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`
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`
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`
head_office	string Filter results by exact head_office. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
branch_profile	string Filter results by exact branch_profile. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
enable_display_currency	string Filter results by exact enable_display_currency. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
display_currency	string Filter results by exact display_currency. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`
convert_listing_price	string Filter results by exact convert_listing_price. 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`
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`
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`
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`
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`
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`
map_x_position	string Filter results by exact map_x_position. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`
map_y_position	string Filter results by exact map_y_position. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__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`
fb_oauth_access_token	string Filter results by exact fb_oauth_access_token. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
fb_page_token	string Filter results by exact fb_page_token. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__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`
branch_managers	string Filter results by exact branch_managers. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`
branch_franchisees	string Filter results by exact branch_franchisees. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`
agent_of_the_month	string Filter results by exact agent_of_the_month. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
leads_manager	string Filter results by exact leads_manager. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
referrals_managers	string Filter results by exact referrals_managers. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__range`, `__startswith`
distressed_sales_coordinator	string Filter results by exact distressed_sales_coordinator. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__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`
location	string Filter results by exact location. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
images	string Filter results by exact images. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__len`, `__lt`, `__lte`, `__overlap`, `__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`
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`
map_image	string Filter results by exact map_image. Allowed lookups: `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
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`
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`
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`
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`
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	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_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`
google_business_account_id	string Filter results by exact google_business_account_id. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith`
referral_intra_branch	string Filter results by exact referral_intra_branch. Allowed lookups: `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith`
statistics	string Filter results by exact statistics. Also accepts any `statistics__<lookup>` suffix (e.g. `statistics__in`).

Responses

200

403 You do not have permission to perform this action

500 Internal server error

503 This website is not active