API Reference

List all devices

get
https://api.controlup.com/edge/api/devices

Returns a list of devices managed by your organization, along with information about each device.

Standard requests can return a maximum of 10000 rows across all pages. For example, if page 1 has 7000 rows, page 2 will be cut off at 3000 rows regardless of the number of rows in the dataset. If you need more rows, set export=true and use _source to specify which fields to include in the export. This method returns up to 65536 rows, or your license count (whichever is greater).

Required permissions - None

Query Params
integer
≤ 10000
Defaults to 10000

The number of rows returned per page. The maximum is 10000 rows per page. To return more than 10000 rows on a single page, use the export parameter.

integer
Defaults to 1

The page returned. The number of rows per page is set with the size parameter.

integer

The index of the rows array to start returning data from. The array index starts at 0. For example, if you set from = 2, the first two devices are excluded.

boolean
Defaults to false

Sets whether to return all devices without any pagination. The size, page, and from parameters will be ignored if true. To use this parameter, you must also use the _source parameter to specify which fields to return.

string

If export=true, then this parameter sets which fields to return. You can return multiple fields by sending more query parameters and changing the integer in the parameter name (for example, _source[0]=_id&_source[1]=_created).

string

Filters the returned data based on the specified field name. This parameter must be used in combination with filters[0][type] and filters[0][value] to define a filter condition.
You can add multiple filter conditions by changing the integer in the parameter names (for example, filters[1][field]).

string
enum

The type of filter used in corresponding filter condition. The type of filter you can use depends on the data type of the field.


<, <=, =, !=, <=, or > are used to filter numbers and dates.

boolean is used to filter boolean fields.

like is used to filter text fields.

The value used in the corresponding filter condition. The value you can use depends on the filter type.


If you are filtering a date or text field, enter a string. If you are filtering a number field, enter a number. If you are filtering a boolean field, enter a boolean. If you are filtering a text field, you can use * as a wildcard, or begin the string with !! to exclude items that contain the string.

string

Sorts the returned data based on the specified field name. This parameter must be used in combination with sorters[0][dir] to set the sort order.
You can sort by more than one field by changing the integer in the parameter names (for example, sorters[1][field]). Sorters with a lower integer are applied first.

string
enum

The sort order for the corresponding field. Set to asc for ascending, or desc for descending.

Allowed:
Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?