Get user groups

This endpoint is used to retrieve the details of the user groups.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{orgId}/userGroups

Sample URLs

https://{api-url}/api/v2/tenants/client_93/userGroups?pageNo=1&pageSize=5&isDescendingOrder=true&sortName=userGroup.id
https://{api-url}/api/v2/tenants/msp_92/userGroups?pageNo=1&pageSize=5&isDescendingOrder=true&sortName=userGroup.id

Parameters

The parameters are optional:

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

Sample response

{
	"results" : [
		{
			"id" : 13,
			"name" : "Network Group",
			"userCount" : 2
		},
		{
			"id" : 10,
			"name" : "Implementation Group",
			"userCount" : 13
		}
	],
	"totalResults" : 2,
	"orderBy" : "userGroup.id",
	"pageNo" : 1,
	"pageSize" : 10,
	"totalPages" : 1,
	"nextPage" : false,
	"nextPageNo" : 0,
	"previousPageNo" : 0,
	"descendingOrder" : true
}