Endpoints that return a paginated list of results use query parameters to filter results. There is a separate query parameter to filter each field in the resource. There is also a _search parameter to filter any field in the resource. Query parameter filters obey the following rules:
- All filters use a contains operator. This means if you search for users named "tim", the API can return users named timothy or mortimer.
- Filters are not case-sensitive.
- Multiple filters on the same query parameter are combined with an OR operator.
- Filters across different query parameters are combined with an AND operator.
Examples
The following request returns only users with 'controlup' in the email field:
The following request returns users with either 'controlup' or 'acmeorg' in the email fields:
The following request returns only users with 'Oliver' in the firstName field AND 'controlup' in the email field.
The following request returns only users with 'Oliver' located in any field.
