Skip to main content

Pagination and filtering

List endpoints share one pagination contract and one filter contract. Learn them once and they apply across all three modes.

Pagination

Send pageId and pageSize in the body. Pages are 1-based.

FieldTypeDescription
pageIdinteger1-based page number. Defaults to 1.
pageSizeintegerRecords per page. Defaults to 10, maximum 100.
{
"orgId": 105,
"tenantId": 1,
"pageId": 1,
"pageSize": 10
}

Filtering

Filters are objects, not query strings. filterBy names the column and value is matched against it.

{
"search": "",
"filter": {
"filterBy": "DEVICE_NAME",
"value": "Microsoft NPS"
}
}
FieldTypeDescription
searchstringFree-text search across the primary display columns. Empty string means no search.
filter.filterBystringColumn key to filter on. Valid keys vary by endpoint.
filter.valuestringExact value to match against the named column.

Combining the two

search and filter apply together and narrow the result set. Pagination is applied after filtering, so totalCount reflects the filtered set.