Docs

Lists, pages and filters

List endpoints page with page and per_page, and accept search and simple filters.

List endpoints return { data: [...], meta: { page, per_page, total } }.

  • page starts at 1.
  • per_page defaults to 50.
  • search matches addresses and names where the endpoint shows it.

Useful filters:

Endpoint Filter
GET /api/v1/properties search, include_archived=true
GET /api/v1/rent-reviews tenancy_id, search
GET /api/v1/issued-documents property_id, kind (for example form_4a)

Archived properties are left out unless you ask for them. Anything under a legal hold is always returned and is read-only.