​Pagination & Filtering

All endpoints that return collections of items support pagination, some endpoints also support filtering.

Currently, the following endpoints support filtering:

• devices

​Pagination

The API supports pagination for endpoints returning collections by supplying limit and offset query parameters.

curl -X GET "https://api.securithings.com/v1/assets/devices?limit=10&offset=0" \
      -H "Authorization Bearer <token>"

By default, if no limit and offset are provided, the API will return the first 100 items.

​Filtering

Currently only the devices endpoint supports filtering by providing query parameters, You can apply filters to refine the results based on specific device attributes.

Available filters:

• status - The connectivity status of the device. Possible values are online, offline, partial, unknown.
• lifeCycleStatus - The life cycle stage of the device. Possible values are current_product, eol (End of Life), eos (End of Support), unknown.
• isFirmwareVulnerable - Indicates if the device has a known firmware vulnerability. Possible values are 1 (Yes) or 0 (No).
• isFirmwareLatest - Indicates if the device is running the latest firmware version supported by the MGMT. Possible values are 1 (Yes) or 0 (No).
• isFirmwareUpgradeAvailable - Indicates if a firmware upgrade task is available for the device. Possible values are 1 (Yes) or 0 (No).

​Combining Filters

You can combine multiple filters for more complex queries. For example:

curl -X GET "https://api.securithings.com/v1/assets/devices?status=offline&isFirmwareVulnerable=1&lifeCycleStatus=eos" \
      -H "Authorization Bearer <token>"

This query retrieves all offline devices that are End of Support (EOS) and have known firmware vulnerabilities."