Documentation is now available for the Fall 2020 Update release!

Get users of a user group

This endpoint is used to fetch users belonging to a user group.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/userGroups/{userGroupId}/users

Sample URLs

To get users of a partner-level user group:

https://{api-url}/api/v2/tenants/msp_1/userGroups/USRGRP-27cfc011-db01-cbe3-5ed4-d46a192d0566/users?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id

To get users of a client-level user group:

https://{api-url}/api/v2/tenants/client_2/userGroups/USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567/users

Parameters

All parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id

Status code

200 OK

Sample response

{
	"results": [{
			"id": "USR0000000029",
			"loginName": "john.smith",
			"lastName": "Smith",
			"firstName": "John",
			"email": "john.smith@myorganization.com"
		},
		{
			"id": "USR0000000014",
			"loginName": "james.hudson",
			"lastName": "Hudson",
			"firstName": "James",
			"email": "james.hudson@myorganization.com",
			"phoneNumber": "+805 123 1234"
		}
	],
	"totalResults": 2,
	"orderBy": "id",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}