Best practices

Filtering and paging

Every endpoint that returns a list accepts filterBy, sortBy and paginateBy. Using them is the easiest way to cut the size of a response.

• Filter server-side. Pulling a full list to keep a few rows wastes bandwidth on both ends.
• Page through long lists, and read the post-filter-result-size response header to know when to stop.
• You often do not need a dedicated endpoint. Filtering a general list answers questions that have no call of their own, such as which terminals belong to one user.

Syntax and examples:

• Customer API (CAPI) — filtering & paging →
• Partner API (PAPI) — filtering & paging →