How to Filter Current Residents Using the /residents Endpoint

While there isn't a direct "current residents" filter available on the /residents endpoint, you can effectively filter for active/current residents by examining the lease status associated with each resident. Here's how to approach this:

Using Lease Status to Determine Current Residents

1. Access the /leases endpoint with the status_normalized filter to retrieve lease data for leases of a specific case (likely ACTIVE).

2. If not filtering, look for the status_normalized field within each lease object.

3. For each lease, examine the residents_meta_data array within the lease object. Each of these residents are associated with the lease.

Understanding "Current" Residents

The concept of a "current" resident can vary depending on the property management system and specific use case. Consider the following when defining "current":

• Is the resident active on their current lease?

• Has the resident moved to another lease within the same property?

• Is the resident still living at the property in general?

• Is the status relative to a specific unit or lease?

Additional Considerations

When working with resident data, you may also need to consider:

• Handling residents with multiple leases or complex residency histories

• How does your use case defined being a "current" resident

If you need more specific guidance on these topics or have questions about implementing this filtering approach, please contact our support team for further assistance.