The API section provides a set of data retrieval endpoints for reading and syncing Warden data with your own systems. Use these to fetch companies, channels, bookings, residents, payments, and transactions.All endpoints in this section support pagination via the following query parameters:| Parameter | Type | Default | Description |
|---|
page | number | 0 | Page number, zero-indexed (i.e. first page is page=0) |
per_page | number | 50 | Number of records per page (max: 10000) |
Filtering Strategy#
Filters are passed as a single q query parameter using a structured syntax. This allows you to combine multiple filters in one request.Syntax#
q=<filterKey><operator><value>
Combining Multiple Filters#
Use $$ as a separator to combine multiple filters in a single q parameter:q=<filter1>$$<filter2>$$<filter3>
Operators#
| Operator | Meaning | Best Used For |
|---|
:= | Exact match | IDs, enums, booleans |
~= | Contains (partial match) | Names, phone numbers, text search |
>= | Greater than or equal | Dates, numeric ranges |
<= | Less than or equal | Dates, numeric ranges |
!= | Not equal | Excluding specific values |
Examples#
# Exact match on a single field
GET /api/v1/external-app/get-bookings?q=propertyId:=412
# Partial text search
GET /api/v1/external-app/get-residents?q=searchText~=John
# Date range filter
GET /api/v1/external-app/get-payments?q=dueDate>=2026-07-01$$dueDate<=2026-07-31
# Combine different filters
GET /api/v1/external-app/get-bookings?q=propertyId:=412$$status:=Pending$$createdAt>=2026-01-01
searchText Filter#
Most endpoints support a searchText filter key that performs a broad search across multiple fields at once — such as name, phone, email, room name, and ID. This is the quickest way to look up a specific record without knowing the exact field to filter on.# Search across all supported fields
GET /api/v1/external-app/get-residents?q=searchText~=+9198801
Sorting#
All endpoints support sorting via the following query parameters:| Parameter | Type | Description |
|---|
sort | string | The field to sort by (e.g. createdAt, updatedAt). Supported sort keys vary per endpoint — refer to each endpoint's documentation |
order | string | Sort direction: asc or desc (default: desc) |
Modified at 2026-05-03 12:44:00
