API V2 Common Query Filters
Last updated: August 28, 2026
Housing.Cloud utilizes common data filters in API V2 collection queries to provide complex filtering. The filters must be a part of the URL and follow the pattern of <baseUrl>?<key>=<filter>&... Below are the type definitions for the common filters.
Common Types Used in Filtering
Generic Equivalence Operator
| Value | Description |
|---|---|
lt |
Collection values are less than the target value |
gt |
Collection values are greater than the target value |
lte |
Collection values are less than or equal to the target value |
gte |
Collection values are greater than or equal to the target value |
String Equivalence Operator
By default, all evaluations are case sensitive
| Value | Description |
|---|---|
equals |
Collection values equal the target value |
contains |
Collection values contain the target value |
startsWith |
The prefix of the collection values is equal to the target value |
endsWith |
The suffix of the collection values is equal to the target value |
Filters
Date Filter
The date filter affords complex comparisons of date using the two components below:
| Component | Data Type | Notes |
|---|---|---|
date |
date string | ISO date string |
operator |
Generic Equivalence Operator |
Example: dateCreated={"date":"2025-09-25T13:31:55.357Z", "operator": "lte"}
String Filter
The string filter affords complex comparisons of strings using the three components below:
| Component | Data Type | Notes |
|---|---|---|
value |
string | This is the target value |
operator |
String Equivalence Operator | |
caseSensitivity |
enum string: insensitive or sensitive
|
Whether or not case sensitivity will be enforced |
Example: name={"value":"jane", "operator": "startsWith", "caseSensitivity":"insensitive"}