Search Listing Portal Configs
Search Listing Portal Config 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/listings/api/v1/portal-configs/search/
Example Response
{"count": 0,"next": "http://www.example.com","previous": "http://www.example.com","results": [{"id": 0,"site": 0,"statistics": 0,"source_ref": "string","last_log": 0,"created": "2026-09-08T14:40:55.915Z","modified": "2026-09-08T14:40:55.915Z","deleted": "2026-09-08T14:40:55.915Z","uuid": "770bba28-9f80-4d40-9c51-6e022364af91","portal": -2147483648,"active": false,"expiration_date": "string","reference": "string","last_message": "string","feed_status": "string","on_portal": false,"development_id": -2147483648,"publish_street_address": false,"publish_map_to_address": false,"publish_feature_notes": false,"display_price": "string","exclusive_listing": false,"exclusive_time_period": 0,"zoning": "string","multi_listing_service": false,"delayed_until": "2026-09-08T14:40:55.915Z","url": "http://www.example.com","residential": 0,"holiday": 0,"commercial": 0,"project": 0}]}
| Name | Description |
|---|---|
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`, `__any`, `__contained_by`, `__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`). |
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` |
last_log | string Filter results by exact last_log. Also accepts any `last_log__<lookup>` suffix (e.g. `last_log__in`). |
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` |
portal | string Filter results by exact portal. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__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` |
expiration_date | string Filter results by exact expiration_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` |
reference | string Filter results by exact reference. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith` |
last_message | string Filter results by exact last_message. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
feed_status | string Filter results by exact feed_status. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith` |
on_portal | string Filter results by exact on_portal. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
development_id | string Filter results by exact development_id. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
publish_street_address | string Filter results by exact publish_street_address. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
publish_map_to_address | string Filter results by exact publish_map_to_address. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
publish_feature_notes | string Filter results by exact publish_feature_notes. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
display_price | string Filter results by exact display_price. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith` |
exclusive_listing | string Filter results by exact exclusive_listing. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
exclusive_time_period | string Filter results by exact exclusive_time_period. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__contained_by`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
zoning | string Filter results by exact zoning. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith` |
multi_listing_service | string Filter results by exact multi_listing_service. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__lt`, `__lte`, `__range`, `__startswith` |
delayed_until | string Filter results by exact delayed_until. **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` |
url | string Filter results by exact url. **Allowed lookups:** `__or`, `__not`, `__ornot`, `__endswith`, `__gt`, `__gte`, `__iendswith`, `__in`, `__isnull`, `__isnullorempty`, `__istartswith`, `__length`, `__lt`, `__lte`, `__range`, `__startswith` |
residential | string Filter results by exact residential. Also accepts any `residential__<lookup>` suffix (e.g. `residential__in`). |
holiday | string Filter results by exact holiday. Also accepts any `holiday__<lookup>` suffix (e.g. `holiday__in`). |
commercial | string Filter results by exact commercial. Also accepts any `commercial__<lookup>` suffix (e.g. `commercial__in`). |
project | string Filter results by exact project. Also accepts any `project__<lookup>` suffix (e.g. `project__in`). |