Most top-level API resources have support for bulk fetches via "list" API methods. Our system uses a single universal format of pagination. Each base item is optional

"filter": [
"operator": "=",
"value": "3"
"search" : "term",
"sort": [
"order": "ASC"


Search will do a text search of all fields specified by the endpoints information


Sort is an array of sorts, though some calls will only support single sort.

Key is required for a sort, and fields are specified by the endpoints information

Order is optional, and if not set will default to ASC (ASC and DESC are the valid values)


Filtering is aa array of filter options. Each filter is one of 3 types, which specify which type of operator is available. the filter type is determined by the field and the endpoint

Filter types:
Type Valid Operators
Time '>=', '<='
String '=', '!=', 'IN', 'NOT IN'
Number '=', '!=', '>=', '<=', 'IN', 'NOT IN'
Key is required, and is specified by the endpoint information

Operator is required, and valid values are specified by the filter type

Value is required, and valid values will be determined based on field and operator.

For a IN or NOT IN filter, a comma separated list is appropriate

NOTE: This means that currently the IN and NOT IN operators do NOT support values with commas in the string EXCEPT as a separator