NidoInstall

Summary

Retrieve multiple resident records from the Nido Property Management API, optionally filtered by building, role, or status, with configurable pagination.

Inputs

• filters — Optional collection of filter criteria. Available options: building_id (number), role (options: resident/moderator/council/admin), status (options: owner_occupant/owner_landlord/tenant/temporary). Default: empty object (no filtering).
• returnAll — When false (default), returns up to limit results from the first page. When true, paginates through all available pages (100 items per page) and returns the complete result set.
• limit — Maximum number of results to return when returnAll is false. Accepts values 1–100, default 25. Only applies when returnAll is false.

Output shape

Array of resident objects as returned by the Nido API GET /api/v1/residents endpoint. Query parameters building_id, role, and status are passed as filters when provided.

If returnAll is false, the response contains at most limit items from page 1. If returnAll is true, all items across all pages are returned (stopping when a page returns fewer than 100 items).

Examples

Example 1: Get up to 10 residents in a specific building

Set limit to 10, set filters.building_id to the desired building ID, leave returnAll as false (default).

Example 2: Get all residents with role moderator

Set returnAll to true, set filters.role to 'moderator', leave limit at default (25) but it is ignored when returnAll is true.