This endpoint returns a list of tenants filtered with the specified parameters.
min_move_in_date
) and/or maximum (max_move_in_date
) move in date range.
You can retrieve tenants for leases belonging specific group via the group’s ID.
You can retrieve tenants with a lease at a particular address, with the possibility of narrowing or broadening the search by providing more or less address data.
You can provide either a group id through the group_id
parameter or a group external reference through the group_external_ref
attribute to filter the list of retrieved tenants down.
Do not provide both, as this will result in the request failing.
If no group_id or group_external_ref are specified in the request body, the authenticated user will retrieve tenant records for all groups they have access to.
last_id
.after-id
parameter to load the next set of results.If there are no more results to load, this value will be -1.