Endpoint: people
For all the people GET APIs, the responses returned by the API corresponds to the people state at the last check-in.
HTTP Method
GET People
Request URI
https://people-and-device-inventory.p.rapidapi.com/api/apigatewaydataservices/v1/people
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": 358,
"value": [
{
"LoginID": "[email protected]",
"FirstName": "Howard",
"EmployeeNumber": "248",
"Groups_pkAttrName": "name",
"Guid": "1af79790-c0af-405b-935e-4ef63e38a0cc",
"Prefix": "Emergency Nurse",
"Manager": "CN=Bobby Hill,OU=Sydney,OU=Healthcare,DC=DemoKit,DC=org",
"PhoneNumbers_pkAttrName": "Number",
"JobTitle": "Emergency Nurse",
"Name": "Howard Hunter",
"Groups_pkAttrName_name": "true",
"Department": "Nursing",
"Emails_pkAttrName": "Email",
"FullName": "Howard Hunter",
"PhoneNumbers_pkAttrName_Number": "true",
"LastName": "Hunter",
"Emails_pkAttrName_Email": "true",
"Application": {
"AD": {
"ContextType": "Domain",
"CreationDate": "2019-07-02T15:44:18.000Z",
"SamAccountName": "Howard.Hunter",
"PasswordNotRequired": "false",
"DistinguishedName": "CN=Howard Hunter,OU=Sydney,OU=Healthcare,DC=DemoKit,DC=org",
"PasswordNeverExpires": "false",
"Enabled": "true",
"AllowReversiblePasswordEncryption": "false",
"LastPasswordSet": "2019-07-02T15:44:18.1969399Z",
"DisplayName": "Howard Hunter",
"DelegationPermitted": "true",
"SmartcardLogonRequired": "false",
"BadLogonCount": "0",
"ChangedDate": "2019-12-05T22:09:05.000Z",
"ContextName": "demokit.org"
}
},
"Emails": [
{
"Type": "Work",
"Email": "[email protected]"
}
],
"Groups": [
{
"name": "CN=Emergency Nurse,OU=Groups,DC=DemoKit,DC=org"
},
{
"name": "CN=Sydney,OU=Groups,DC=DemoKit,DC=org"
},
{
"name": "CN=Healthcare,OU=Groups,DC=DemoKit,DC=org"
},
{
"name": "CN=Nursing,OU=Groups,DC=DemoKit,DC=org"
}
],
"Location": {
"Office": "Sydney",
"City": "Sydney"
},
"PhoneNumbers": [
{
"Type": "Work",
"Number": "+61 2 4645 5467"
}
],
"Dexi": {
"ScoreDate": "2023-09-18T12:14:07.757Z",
"Score": "60",
"SecuritySubscore": "60",
"Class": "Green",
"Devices": "[]",
"ApplicationSubscore": "60",
"HardwareSubscore": "60"
},
"DiscoveryId": "AYWjLv0zfaV1Jl2eFUHg"
}
],
"@odata.nextLink": "https://people-and-device-inventory.p.rapidapi.com:443/api/apigatewaydataservices
/v1/people?$scrollID=DnF1ZXJ5VGhlbkZldGNoAgAAAAAbkqdWFnFHX2dLTTYwU0Q2dWdnaHhYNGN1NkEAAAAAGGj
7eRZRYXBQaEtwWFFsNmp3MnY1Q1pVZnVB"
}HTTP Method
GET People Attributes Metadata
Request URI
https://people-and-device-inventory.p.rapidapi.com/api/apigatewaydataservices/v1/peopleMetadata
Example response
The responses are available in XML format, and the OData metadata describes the people object and its properties and attributes.