Pagination & Filters

Pagination

All responses are returned paginated.

The default limit is 25, however if you choose you may pass your preferred limit as a query string parameter.

?limit=3

Filters

Filters are available on most endpoints and available filters are specified in the documentation for that endpoint.

Filters add where clauses to your query and will further specify the returned dataset. You can use multiple filters to limit your returned dataset.

Filters are passed as a properly url encoded array in the query string where the filter[key] is desired filterable and the value is the desired query value.

Examples in documentation are in readable format:

?filter[divisionId]=20&filter[startDate]=2023-01-01

URL Encoded example:

%3Ffilter%5BdivisionId%5D%3D20%26filter%5BstartDate%5D%3D2023-01-01

Arrays of values (multiple values):

Some filters are able to handle arrays of values and will be notated as such in the documentation in readable format for that endpoint.

?filter[divisionId][]=20&filter[divisionId][]=21
OR
?filter[divisionId]=20,21