Skip to content

Filtering & Pagination

The Juniper API supports filtering and pagination of collections using query parameters that follow the Apache standard.

page

Return a specific page of results. The default page size is 25.

limit

Set the results per page. The default page size is 25.

sort

Sort the results by a specific field. The default sort order is ascending, but descending can be specified by prefixing the field name with a -. Multiple fields can be sorted by separating them with a comma.

/resources?sort=name,-date_of_birth

q

Freetext search across multiple fields. The fields that are searched are determined by the API, but typically includes the useful fields a human could conceivably want to use (eg. name, email_address, postcode).

/resources?q=George

filter

Many endpoints support a number of pre-defined named filters. These filters are documented in the API reference for each endpoint.

/resources?filter=active

See also