Skip to main content

​
Filtering

Several endpoints support filtering to allow you to retrieve only the data you need. For example, you can filter incidents by status:
Each endpoint may support different fields for filtering. Check the documentation for the specific endpoint you are working with.
Many endpoints can embed related resources in the response using the include parameter. Pass a comma-separated list of the relationships you want to include:
Each endpoint supports a different set of includes. Check the documentation for the specific endpoint you are working with.

​
Filtering by metadata

Resources that support metadata can be filtered by their metadata keys using the filter[meta][key] syntax:

​
Sorting

You can sort the results of an endpoint by passing the sort parameter. The sort parameter should be a comma-separated list of fields to sort by. You can also specify the sort order by appending asc or desc to the field name.
To reverse the sort order, you can prefix the field name with a hyphen.
Each endpoint may support different fields for sorting. Check the documentation for the specific endpoint you are working with.