List all Devices

GET {{baseUrl}}/api/v1/devices

Lists all devices with pagination support.

A subset of Devices can be returned that match a supported search criteria using the search query parameter.

Searches for devices based on the properties specified in the search parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match search request.

Note: Listing devices with search should not be used as a part of any critical flows—such as authentication or updates—to prevent potential data loss. search results may not reflect the latest information, as this endpoint uses a search index which may not be up-to-date with recent updates to the object.
Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss.
Use an id lookup for records that you update to ensure your results contain the latest data.

This operation equires URL encoding. For example, search=profile.displayName eq "Bob" is encoded as search=profile.displayName%20eq%20%22Bob%22.

Request Params

KeyDatatypeRequiredDescription
afterstringThe cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination for more information.
limitnumberA limit on the number of objects to return.
searchstringSCIM filter expression that filters the results. Searches include all Device profile properties, as well as the Device id, status and lastUpdated properties.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{"created":"1949-09-05T02:56:44.128Z","id":"mollit","lastUpdated":"1988-10-25T22:15:07.213Z","profile":{"displayName":"pariatur occaecat","platform":"ANDROID","registered":false,"imei":"ut consequat es","manufacturer":"dolor sint non cupidatat pariatur","meid":"labo","model":"aute cupidatat fugiat dolore culpa","osVersion":"eu Ut","secureHardwarePresent":true,"serialNumber":"velit ut ipsum","sid":"dolore in aliqua sint elit","tpmPublicKeyHash":"adipisicing veniam minim nisi Ut","udid":"id sint irure"},"resourceAlternateId":"ea in","resourceDisplayName":{"sensitive":false,"value":"labore nisi n"},"resourceId":"qui ullamco cillum","resourceType":"UDDevice","status":"DEACTIVATED","_links":{"self":{"href":"proident amet aute","hints":{"allow":["GET","DELETE"]},"name":"mollit","type":"dolore fugiat irure"},"users":{"href":"sint nostrud amet adipisicing ea","hints":{"allow":["DELETE","DELETE"]},"name":"laboris est pariatur do","type":"aliqua ut ex velit"},"activate":{"href":"reprehenderit nisi proident consectetur Ut","hints":{"allow":["PUT","PUT"]},"name":"ad do Duis ex","type":"in eu nisi"},"deactivate":{"href":"minim ea culpa","hints":{"allow":["GET","PUT"]},"name":"dolor eu mollit aute Duis","type":"exercitation"},"suspend":{"href":"ad qui aliqua exercitation ven","hints":{"allow":["POST","POST"]},"name":"ipsum sint aliqua","type":"ad do incididunt"},"unsuspend":{"href":"aute sit","hints":{"allow":["POST","DELETE"]},"name":"irure mollit dolor u","type":"ex"}}},{"created":"2019-06-11T15:05:47.635Z","id":"exercitation in in id","lastUpdated":"1962-02-21T15:05:52.222Z","profile":{"displayName":"laboris","platform":"WINDOWS","registered":false,"imei":"aliquip dolor in","manufacturer":"ut officia","meid":"a","model":"veniam sint cillum","osVersion":"veniam esse","secureHardwarePresent":false,"serialNumber":"dolore tempor","sid":"culpa id i","tpmPublicKeyHash":"reprehenderit ullamco sint eiusmod","udid":"nisi ullamco ma"},"resourceAlternateId":"non ut Excepteur ipsum","resourceDisplayName":{"sensitive":false,"value":"Lorem"},"resourceId":"est aliquip culpa","resourceType":"UDDevice","status":"ACTIVE","_links":{"self":{"href":"co","hints":{"allow":["PUT","DELETE"]},"name":"cupidatat magna nostrud","type":"elit cillum officia"},"users":{"href":"eiusmod","hints":{"allow":["PUT","PUT"]},"name":"reprehenderit voluptate id","type":"cupidatat sunt sit"},"activate":{"href":"sed occaecat in","hints":{"allow":["DELETE","POST"]},"name":"dolor est veniam incididunt","type":"veniam adipisicing"},"deactivate":{"href":"aliqua cupidatat minim magna sunt","hints":{"allow":["PUT","PUT"]},"name":"nostrud consectetur eu","type":"ipsum labore"},"suspend":{"href":"ut voluptat","hints":{"allow":["PUT","DELETE"]},"name":"elit quis","type":"exercitation nostrud esse magna anim"},"unsuspend":{"href":"commodo ullamco elit exercitation magna","hints":{"allow":["DELETE","DELETE"]},"name":"Duis in voluptate","type":"voluptate non"}}}]