Queries

Queries are for reading data. We typically support filtering, sorting, pagination and aggregation where we return lists of data.

We will not change any entities from a query.

note

• Using fragments is recommended
• For more responsive queries we recommend requesting only the necessary data as we will only read the requested data from the database.
• For better performance always use variables instead of adding parameters directly in the query body

Schema

The Orchestrate APIs are versatile, accommodating a variety of query types. Depending on the specific requirements of the use case, different segments of the API schema can retrieve varying degrees of data from the database.

Here are some of the most frequently utilised query categories within our API: