Management API
Device

List Devices

5min

Show all devices the requesting manager has access permissions to.

URL: /api/v1/devices/

Method: GET

Query Parameters:

Ordering:

  • order_by - Which attribute to order the list by.
    • default ordering is ascending, can be made descending by prefixing the attribute name with -
    • Example: order_by=created_at
    • Example: order_by=-created_at

Pagination:

Default pagination is 20 results per page.

  • limit - Number of results to return per page.
    • Example: limit=20
  • offset - The initial index from which to return the results.
    • Example: offset=21

Filtering:

The results can be filtered by various attributes on device or related to the device.

Possible filters:

  • license
  • blacklisted
  • hostname
  • hardware_id
  • os

Success Response:

Code: 200 OK

Content Examples:

JSON