Get
/v2/identity/users
Retrieve the list of users specifying
Required permissions: READ_ALL_USERS.
Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired
The name of the target tenant (e.g. acme).
Query parameters
email
string
Condition on email address.
For more details on predicates, see the payload common concepts article.
Exampleeq;mark.hamill@acme.com
size
integer
The number of elements to retrieve for the current page.
Minimum1.0
Example200
page
integer
The page number to retrieve (zero-based).
Minimum0.0
Example0
sort
string
The sorting criteria based on object properties.
Minimum0.0
Examplename,ASC
Responses
200
Successful operation.
object
content
Array of object (User)
object
id
string
email
string
firstName
string
lastName
string
devices
Array of object (Device)
object
deviceId
string
os
string
ExampleAndroid_9, iSO_11
model
string
ExampleONEPLUS A6013
platform
string
Valid values[
"Android",
"iOS"
]
notificationDeviceId
string
userTypeName
string
organizationId
string
partnerId
string
customerId
string
locationId
string
timezone
string
language
string
termsOfServiceAcceptedTimestamp
integer (int64)
privacyPolicyAcceptedTimestamp
integer (int64)
firstAccessTimestamp
integer (int64)
lastAccessTimestamp
integer (int64)
hostCustomers
Array of object (HostCustomer)
object
customerId
string
userType
object
id
string
name
string
category
string
rank
integer
commandPayloadDuration
integer
permissions
Array of string
string
status
string
Valid values[
"PENDING_ACTIVATION",
"ACTIVE"
]
creationTimestamp
integer (int64)
alertActivatedInformationalEmailEnabled
boolean
alertClearedInformationalEmailEnabled
boolean
alertActivatedWarningEmailEnabled
boolean
alertClearedWarningEmailEnabled
boolean
alertActivatedFailureEmailEnabled
boolean
alertClearedFailureEmailEnabled
boolean
alertActivatedCriticalEmailEnabled
boolean
alertClearedCriticalEmailEnabled
boolean
alertActivatedEmergencyEmailEnabled
boolean
alertClearedEmergencyEmailEnabled
boolean
alertActivatedInformationalSmsEnabled
boolean
alertClearedInformationalSmsEnabled
boolean
alertActivatedWarningSmsEnabled
boolean
alertClearedWarningSmsEnabled
boolean
alertActivatedFailureSmsEnabled
boolean
alertClearedFailureSmsEnabled
boolean
alertActivatedCriticalSmsEnabled
boolean
alertClearedCriticalSmsEnabled
boolean
alertActivatedEmergencySmsEnabled
boolean
alertClearedEmergencySmsEnabled
boolean
alertActivatedInformationalPushEnabled
boolean
alertClearedInformationalPVoicenabled
boolean
alertActivatedWarningPushEnabled
boolean
alertClearedWarningPushEnabled
boolean
alertActivatedFailurePushEnabled
boolean
alertClearedFailurePushEnabled
boolean
alertActivatedCriticalPushEnabled
boolean
alertClearedCriticalPushEnabled
boolean
alertActivatedEmergencyPushEnabled
boolean
alertClearedEmergencyPushEnabled
boolean
alertActivatedInformationalVoiceEnabled
boolean
alertClearedInformationalVoiceEnabled
boolean
alertActivatedWarningVoiceEnabled
boolean
alertClearedWarningVoiceEnabled
boolean
alertActivatedFailureVoiceEnabled
boolean
alertClearedFailureVoiceEnabled
boolean
alertActivatedCriticalVoiceEnabled
boolean
alertClearedCriticalVoiceEnabled
boolean
alertActivatedEmergencyVoiceEnabled
boolean
first
boolean
last
boolean
totalPages
integer
totalElements
integer
sort
string
numberOfElements
integer
size
integer
number
integer
Minimum0.0
401
User not authenticated.
object
message
string
The error response.
ExampleUser not authenticated
403
User not authorized.
object
message
string
The error response.
ExampleUser not authorized
404
Resource was not found.
object
message
string
The error response.
ExampleResource not found
429
API call rate limit exeeded.
object
message
string
The error response.
ExampleAPI call rate limit exeeded
500
Internal server error.
object
message
string
The error response.
ExampleInternal Server Error