Skip to content

Query Devices

Request

Returns a list of managed devices matching the query from the token-linked endpoint management source.

Operation ID: endpointmanagement_query_devices

Security
BearerAuth
Query
metaArray of strings

Add metadata to the response by invoking meta functions. Documentation for meta functions is available. Not all meta functions are available at every endpoint.

limitinteger or null

Number of devices to return. Defaults to 50. A page may hold fewer results than limit, or none, even when more remain; keep paging until the returned cursor is empty.

cursorstring or null

Start search from cursor position.

orderArray of strings

Select a field to order the results by. To control the direction of the sorting, append [asc] or [desc] to the field name. For example, device.name[asc] will sort the results by device.name in ascending order. The ordering defaults to asc if not specified.

filterArray of strings

Filter results by this query. For more information on filtering, refer to our Filtering Guide. Defaults to no filter. If used more than once, the queries are ANDed together.

curl
curl -i -X GET \
  https://api.synqly.com/v1/endpoint-management/devices \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
cursorstringrequired

Cursor to use to retrieve the next page of results

resultArray of objects(ocsfv1.3.0inventoryinfoInventoryInfo)required

List of devices that match the query.

messagesobject or null(MessagesResponse)

Additional messages from the service response that may be helpful to the client.

metaobject or null(MetaResponse)

Various metadata about the results organized by group, then type, then field.

Response
{ "result": [ { … } ], "cursor": "string", "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }