Filtering is useful to give you a subset of results when you get results that would require parsing.

Some GET operations return a significant amount of information in the response. Rather than parse the information locally, some of the REST API endpoints permit you to filter using query parameters. Not all APIs provide these capabilities. An API supports query parameters if you see a QUERY PARAMS section in the API reference.

Filtering Using Provided Query Parameters

If supported, a REST API endpoint can allow you to filter the results using endpoint-specific query parameters for GET operations.

You can use multiple parameters using an ampersand (&) as a delimiter. For example, the GET Events API has multiple query parameters that can be combined as a single request using an ampersand (&) to query shared and applicationDomainId:

For more information, see the documentation for the query parameters for the GET operation.