List units
arthur_list_unitsUnits, vacancy, availability, unit type, market rent and location. GET /v2/units. Returns data plus the vendor pagination; this is one page, not the whole portfolio.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _q | No | ||
| city | No | ||
| page | No | Results page (default 1). Read pagination.pageCount before requesting the next page. | |
| sort | No | Vendor field to sort by, for example id or created. | |
| limit | No | Records per page, 1–100 (default 20). | |
| postcode | No | ||
| unit_ref | No | ||
| direction | No | Sort direction (default ASC when sorting). | |
| unit_status | No | ||
| unit_vacant | No | ||
| unit_owner_id | No | Arthur numeric record id, from the corresponding list tool. | |
| available_move_in_date | No | Calendar date in YYYY-MM-DD format. | |
| available_move_out_date | No | Calendar date in YYYY-MM-DD format. |