Using pagination

Paging can be used in some lists to limit the number of items returned and to sort the lists.

Parameters

Limit

Indicates the maximum number of items to return, this value must be an integer number equal or above 1.
If not specified, all items will be returned, and the Offset value will be ignored.

Examples:
  • return the top 10 Items/Assets (by default, sorted by Code)
    /api/Items?Limit=10

Offset

Indicates the number of items to skip from the start, this value must be an integer number equal or above 0.
If not specified, the default value will be 0.
Offset will only work if the Limit is also specified.

Examples:
  • return the top 5 Items/Assets, after skipping the first 3 (by default, sorted by Code)
    /api/Items?Limit=5&Offset=3

Sort

The field name to sort by (case-insensitive), this parameter can be specified by itself, without the need to specify the Limit or Offset.
To sort the list in an descending order, prefix the field name with a minus/dash ("-").
By default, all lists are sorted by Code or Id.

Examples:
  • return all Items/Assets sorted by System in a descending order
    /api/Items?Sort=-System