Pagination & Filtering

The following query string parameters can be used for paging and filtering results on GET calls that return multiple items.

ParameterDescription
countNumber of items to return. Default is 10 with a maximum value of 25.
startIndexStart index (starts at 0) of the resources to be returned. Typically used to jump to a specific position in the resource list based on its order. Example for starting at the second item in a list of results: ?startIndex=1
orderByOrder returned items by createdAt or updatedAt.
sortOrderSort based on order of results. Options include asc for ascending order or desc for descending order (default).
createdAt.startResource create time (Unix Timestamp) that indicates the start of a range of results.
createdAt.endResource create time (Unix Timestamp) that indicates the end of a range of results.
updatedAt.startResource update time (Unix Timestamp) that indicates the start of a range of results.
updatedAt.endResource update time (Unix Timestamp) that indicates the end of a range of results.

🚧

Warning

Some resources may have additional filter attributes.


Did this page help you?