Online Docs

Get Users

Retrieve the properties of user. The return properties include all the users base on certain query.

URL Endpoint

api/users

Method

GET.

Parameter

Support OData Filter syntax.

Request

Header

1
2
--x-appvity-groupId: [TeamID]
--Cookie: graphNodeCookie=[ID]

Body

No body for this method.

Response

Retrieves the list of users according to the schema:

1
2
3
4
5
6
{
"_id": "[UserID]",
"displayName": "[UserDisplayName]",
"source": "Microsoft.Graph.User",
"username": "[UserName]"
}

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"@odata.context": "https://schema.appvity.com/odata/$metadata#users",
"@odata.count": 396,
"value": [
{
"_id": "5bce7df753b66e19aaa3e81e",
"displayName": "z Cloud User 1",
"source": "Microsoft.Graph.User",
"username": "clouduser1@anadea.onmicrosoft.com"
},
{
"_id": "5bce7df753b66e19aaa3e825",
"displayName": "z Kate Cloud",
"source": "Microsoft.Graph.User",
"username": "clouduser7@anadea.onmicrosoft.com"
}
]
}

Comment

Was this article helpful?
Thanks For Your Feedback