Get minimal details of users

This endpoint is used to retrieve the minimal details of the users.

Leave Feedback

URL

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

Sample URLs

To retrieve minimal details of partner-level users:

https://{api-url}/api/v2/tenants/msp_92/users/minimal

To retrieve minimal details for all users in a client:

https://{api-url}/api/v2/tenants/client_93/users/minimal

To retrieve minimal details for active users in a client:

https://{api-url}/api/v2/tenants/client_93/users/minimal?queryString=status:active

Parameters

The parameter is optional:

FieldDefault Value
queryString={queryString}status: active

Query variables

Query VariablesDescription
status
  • To fetch list of active users, provide status: active.
  • To fetch list of inactive users, provide status: inactive.

Sample response

[
	{
		"id" : "USR0000000453",
		"loginName" : "John.Smith",
		"lastName" : "Smith",
		"firstName" : "John",
		"email" : "john.smith@domain.com",
		"changePassword" : false
	},
	{
		"id" : "USR0000000216",
		"loginName" : "James.Scott",
		"lastName" : "Scott",
		"firstName" : "James",
		"email" : "james.scott@domain.com",
		"changePassword" : false
	},
	{
		"id" : "USR0000002097",
		"loginName" : "Scarlett.John",
		"lastName" : "Scarlett",
		"firstName" : "John",
		"email" : "scarlett@domain.com",
		"changePassword" : false
	},
	{
		"id" : "USR0000002115",
		"loginName" : "Denny.Partner",
		"lastName" : "Rivers",
		"firstName" : "Denny",
		"email" : "denny.partner@domain.com",
		"changePassword" : false
	}
]