Endpoint: devices

For all the device GET APIs, the responses returned by the API corresponds to the device state at the last device check-in.

HTTP Method

GET Devices

Request URI

https://people-and-device-inventory.p.rapidapi.com/api/apigatewaydataservices/v1/devices

Header Parameters

Name	Type	Description
Authorization	String	Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.
X-RapidAPI-Key	ENUM	The key that applications and developers need to invoke the API.
X-RapidAPI-Host	String	The name that identifies which API will be used. For example: my-api-name.ivanti.rapidapi.com.

Example response

{
"@odata.count": 526,
"value": [
{
"DisplayName": "MJW11AG2SU4",
"DiscoveryId": "AYk_dW1-0weDRYMasUNP",
"DeviceName": "MJW11AG2SU4",
"Network": {
"TCPIP": {
"Address": "10.39.248.116"
}
},
"OS": {
"Version": "Windows 11",
"Name": "Windows 11"
},
"System": {
"Model": "VMware7,1"
}
},
{
"DisplayName": "MJW10EPMAGSU2",
"DiscoveryId": "AYk_eQLmx5p5BYeS8cr_",
"DeviceName": "MJW10EPMAGSU2",
"Network": {
"TCPIP": {
"Address": "10.39.248.130"
}
},
"OS": {
"Version": "Windows 10",
"Name": "Windows 10"
},
"System": {
"Model": "VMware7,1"
}
}
],
"@odata.nextLink":
"https://people-and-device-inventory.p.rapidapi.com:
443/api/apigatewaydataservices/v1/devices?$filter=contains( 
OS/DisplayName, 'Windows')&$scrollID=DnF1ZXJ5VGhlbkZ
ldGNoAgAAAAAZ5IErFktkY0lFTnpsU25pWkpKMExuVGJHdEEAAAAAGsyat
RZwNlROU3hjVFFidWdtN1VpRW}
                                            

GET Devices Metadata

Request URI

https://people-and-device-inventory.p.rapidapi.com/api/apigatewaydataservices/v1/devices

Example response

The responses are available in XML format, and the OData metadata describes the device object and its properties and attributes.

Pagination

When using the Discovery API to retrieve Devices, the server paginates the data, you receive a portion of the results at a time. Typically, you will get 10 to 20 objects per response.

Pagination applies only to retrieving details about people and devices and does not apply to metadata calls.

To access additional results, check the bottom of the response for the @odata.nextLink property. This property contains a URL for fetching the next set of results. The URL includes a scrollID parameter, for example:

@odata.nextLink": https://somewhere.ivanticlouddev.com/api/discovery/v1/device?$scrollID=bm7vZGxlca64384f-c933-4b4c-9603-976a53b55578

Use this scrollID in subsequent requests to continue retrieving data. Keep calling the next link until you receive an empty response, indicating that all results have been fetched.

ScrollID has a 5-minute timeout. If you don't use it within 5 minutes, it will expire. In this case, you'll need to restart the process with your initial request to get a new @odata.nextLink and a fresh scrollID.