Pagination, Searching and Sorting

Many endpoints support pagination, searching, and sorting via query parameters. You can mix and match them as needed. Check each endpoint’s documentation in the Endpoints folder for specifics.

Pagination

All GET endpoints that return lists (e.g., mailboxes, documents, templates) support pagination with page and page_size.

Default page size: 25

Change page size: set page_size

Select a page: set page

Example: GET /parser?page=2&page_size=50

The response has this structure:

Searching

Where supported, use the search parameter to filter results. The value must be URL‑encoded.

Example: /parser?search=test%20mailbox

Unless stated otherwise, search is case‑insensitive and matches substrings.
For example, searching for foo can return test.foo and FOO Mailbox 123.

Sorting

Where supported, use the ordering parameter to sort results by a field:

Ascending: ?ordering=<field>

Descending: ?ordering=-<field>

Example: /parser?ordering=-document_count

This sorts mailboxes by document count in descending order (most documents first).

Combine parameters

You can combine pagination, search, and ordering: /parser?page=1&page_size=50&search=invoice&ordering=-created

Pagination#

Searching#

Sorting#

Combine parameters#

Pagination

Searching

Sorting

Combine parameters