List tenants
street_list_tenantsList tenants. Newest first as Street orders them; page with page and page_size. GET /tenants.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| address | No | Fuzzy match on the full address text. | |
| include | No | Related records to embed in "included". Allowed: tenancies, tenancies.property, tenancies.property.branch, notes. | |
| trashed | No | with = include deleted records, only = only deleted ones (default: not deleted). | |
| page_size | No | Results per page, 1-100 (default 25). | |
| created_to | No | Only records created before this date-time. | |
| updated_to | No | Only records updated before this date-time. | |
| created_from | No | Only records created after this date-time. | |
| updated_from | No | Only records updated after this date-time (use it to sync changes). | |
| email_address | No | Only records with this email address. | |
| person_status | No | current or previous. | |
| telephone_number | No | Telephone number in full international format, e.g. +441614960137. |