This is an archive version of the document. To get the most up-to-date information, see the current version.

Filter System Query Option ($filter)

In this article

The $filter System Query Option is used to filter resource collections to return a subset of resources in a response. The subset includes only those resources that satisfy conditions specified in the query.

For example, to return all users with the Company Administrator role, send the following request:

GET https://<Availability-Console>:1281/v2/users?$filter=role%20eq%20'Company%20Administrator'

The $filter system query option supports a set of built-in filter operations and built-in functions that can be used within these operations. For a full description of the syntax used for building requests, see the [OData‑URL] syntax rule.