Users
Returns a list of users for specified tenant This endpoint returns paged results of up to 10,000 records per response, using the X-CONTINUATIONTOKEN header. When the response includes this token, it indicates that additional records are available. To retrieve the next set of results, include the X-CONTINUATIONTOKEN token from the previous response header in the header of your subsequent request. This process can be repeated until no further continuation token is provided, indicating that you have reached the end of the dataset.
Tenant Var Code
If true, result includes users from subtenants
falseIf true, result include Base64 encoded profile picture
falseOK
Tenant Var Code
The email address that is used as login
A unique identifier of the user
User's password (used for POST, PUT and PATCH only)
The first name of the user
The last name of the user
The unique identifier for the user role
A boolean indicating whether user verified his email
A boolean indicating if account is disabled
A boolean indicating if account is enabled for the portal
A number of invalid login attempts in last time window
A date and time of last invalid login time window start
A date and time when the account was locked because of too many invalid login attempts
A date and time when the user logged in last time
String with comma delimited list of cross tenant collection IDs which are assigned to the user
Pin code for external services
Timestamp (UTC) indicating version of record being returned
Base64 encoded user profile photo. Included in GET request only when photo parameter is specified.
Free form notes that can be added against a user.
User's manager unique identifier
Valid options are Male, Female, Transgender, Non-Binary, Other
Users job title
Users employee Id
User's primary facility ID
List of secondary facility IDs
ETag representing record version
GET /V2/{tenantVarCode}/users HTTP/1.1
Accept: */*
OK
[
{
"TenantCode": "text",
"Username": "text",
"UserId": "text",
"Password": "text",
"FirstName": "text",
"LastName": "text",
"UserRoleId": "text",
"IsApproved": true,
"IsDisabled": true,
"IsPortalEnabled": true,
"FailedPasswordAttemptCount": 1,
"FailedPasswordAttemptWindowStart": "2026-01-01T00:00:00.000Z",
"LastLockoutDate": "2026-01-01T00:00:00.000Z",
"LastLoggedIn": "2026-01-01T00:00:00.000Z",
"CrossTenantCollections": "text",
"PinCode": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Photo": "text",
"Notes": "text",
"ManagerUserId": "text",
"Gender": "text",
"JobTitle": "text",
"EmployeeId": "text",
"FacilityId": "text",
"SecondaryFacilityIds": [
"text"
],
"ETag": "text",
"Tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"CustomFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]Tenant Var Code
Tenant Var Code
The email address that is used as login
A unique identifier of the user
User's password (used for POST, PUT and PATCH only)
The first name of the user
The last name of the user
The unique identifier for the user role
A boolean indicating whether user verified his email
A boolean indicating if account is disabled
A boolean indicating if account is enabled for the portal
A number of invalid login attempts in last time window
A date and time of last invalid login time window start
A date and time when the account was locked because of too many invalid login attempts
A date and time when the user logged in last time
String with comma delimited list of cross tenant collection IDs which are assigned to the user
Pin code for external services
Timestamp (UTC) indicating version of record being returned
Base64 encoded user profile photo. Included in GET request only when photo parameter is specified.
Free form notes that can be added against a user.
User's manager unique identifier
Valid options are Male, Female, Transgender, Non-Binary, Other
Users job title
Users employee Id
User's primary facility ID
List of secondary facility IDs
ETag representing record version
OK
No content
POST /V2/{tenantVarCode}/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 722
{
"TenantCode": "text",
"Username": "text",
"UserId": "text",
"Password": "text",
"FirstName": "text",
"LastName": "text",
"UserRoleId": "text",
"IsApproved": true,
"IsDisabled": true,
"IsPortalEnabled": true,
"FailedPasswordAttemptCount": 1,
"FailedPasswordAttemptWindowStart": "2026-01-01T00:00:00.000Z",
"LastLockoutDate": "2026-01-01T00:00:00.000Z",
"LastLoggedIn": "2026-01-01T00:00:00.000Z",
"CrossTenantCollections": "text",
"PinCode": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Photo": "text",
"Notes": "text",
"ManagerUserId": "text",
"Gender": "text",
"JobTitle": "text",
"EmployeeId": "text",
"FacilityId": "text",
"SecondaryFacilityIds": [
"text"
],
"ETag": "text",
"Tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"CustomFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}OK
No content
Tenant Var Code
User Id
If true, result include Base64 encoded profile picture
falseOK
Tenant Var Code
The email address that is used as login
A unique identifier of the user
User's password (used for POST, PUT and PATCH only)
The first name of the user
The last name of the user
The unique identifier for the user role
A boolean indicating whether user verified his email
A boolean indicating if account is disabled
A boolean indicating if account is enabled for the portal
A number of invalid login attempts in last time window
A date and time of last invalid login time window start
A date and time when the account was locked because of too many invalid login attempts
A date and time when the user logged in last time
String with comma delimited list of cross tenant collection IDs which are assigned to the user
Pin code for external services
Timestamp (UTC) indicating version of record being returned
Base64 encoded user profile photo. Included in GET request only when photo parameter is specified.
Free form notes that can be added against a user.
User's manager unique identifier
Valid options are Male, Female, Transgender, Non-Binary, Other
Users job title
Users employee Id
User's primary facility ID
List of secondary facility IDs
ETag representing record version
GET /V2/{tenantVarCode}/users/{userId} HTTP/1.1
Accept: */*
OK
{
"TenantCode": "text",
"Username": "text",
"UserId": "text",
"Password": "text",
"FirstName": "text",
"LastName": "text",
"UserRoleId": "text",
"IsApproved": true,
"IsDisabled": true,
"IsPortalEnabled": true,
"FailedPasswordAttemptCount": 1,
"FailedPasswordAttemptWindowStart": "2026-01-01T00:00:00.000Z",
"LastLockoutDate": "2026-01-01T00:00:00.000Z",
"LastLoggedIn": "2026-01-01T00:00:00.000Z",
"CrossTenantCollections": "text",
"PinCode": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Photo": "text",
"Notes": "text",
"ManagerUserId": "text",
"Gender": "text",
"JobTitle": "text",
"EmployeeId": "text",
"FacilityId": "text",
"SecondaryFacilityIds": [
"text"
],
"ETag": "text",
"Tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"CustomFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Tenant Var Code
User Id
Tenant Var Code
The email address that is used as login
A unique identifier of the user
User's password (used for POST, PUT and PATCH only)
The first name of the user
The last name of the user
The unique identifier for the user role
A boolean indicating whether user verified his email
A boolean indicating if account is disabled
A boolean indicating if account is enabled for the portal
A number of invalid login attempts in last time window
A date and time of last invalid login time window start
A date and time when the account was locked because of too many invalid login attempts
A date and time when the user logged in last time
String with comma delimited list of cross tenant collection IDs which are assigned to the user
Pin code for external services
Timestamp (UTC) indicating version of record being returned
Base64 encoded user profile photo. Included in GET request only when photo parameter is specified.
Free form notes that can be added against a user.
User's manager unique identifier
Valid options are Male, Female, Transgender, Non-Binary, Other
Users job title
Users employee Id
User's primary facility ID
List of secondary facility IDs
ETag representing record version
OK
No content
PUT /V2/{tenantVarCode}/users/{userId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 722
{
"TenantCode": "text",
"Username": "text",
"UserId": "text",
"Password": "text",
"FirstName": "text",
"LastName": "text",
"UserRoleId": "text",
"IsApproved": true,
"IsDisabled": true,
"IsPortalEnabled": true,
"FailedPasswordAttemptCount": 1,
"FailedPasswordAttemptWindowStart": "2026-01-01T00:00:00.000Z",
"LastLockoutDate": "2026-01-01T00:00:00.000Z",
"LastLoggedIn": "2026-01-01T00:00:00.000Z",
"CrossTenantCollections": "text",
"PinCode": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Photo": "text",
"Notes": "text",
"ManagerUserId": "text",
"Gender": "text",
"JobTitle": "text",
"EmployeeId": "text",
"FacilityId": "text",
"SecondaryFacilityIds": [
"text"
],
"ETag": "text",
"Tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"CustomFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}OK
No content
OK
No content
PATCH /V2/{tenantVarCode}/users/{userId} HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 56
[
{
"value": null,
"path": "text",
"op": "text",
"from": "text"
}
]OK
No content
Tenant Var Code
Username
If true, result include Base64 encoded profile picture
falseOK
Tenant Var Code
The email address that is used as login
A unique identifier of the user
User's password (used for POST, PUT and PATCH only)
The first name of the user
The last name of the user
The unique identifier for the user role
A boolean indicating whether user verified his email
A boolean indicating if account is disabled
A boolean indicating if account is enabled for the portal
A number of invalid login attempts in last time window
A date and time of last invalid login time window start
A date and time when the account was locked because of too many invalid login attempts
A date and time when the user logged in last time
String with comma delimited list of cross tenant collection IDs which are assigned to the user
Pin code for external services
Timestamp (UTC) indicating version of record being returned
Base64 encoded user profile photo. Included in GET request only when photo parameter is specified.
Free form notes that can be added against a user.
User's manager unique identifier
Valid options are Male, Female, Transgender, Non-Binary, Other
Users job title
Users employee Id
User's primary facility ID
List of secondary facility IDs
ETag representing record version
GET /V2/{tenantVarCode}/users/{username} HTTP/1.1
Accept: */*
OK
{
"TenantCode": "text",
"Username": "text",
"UserId": "text",
"Password": "text",
"FirstName": "text",
"LastName": "text",
"UserRoleId": "text",
"IsApproved": true,
"IsDisabled": true,
"IsPortalEnabled": true,
"FailedPasswordAttemptCount": 1,
"FailedPasswordAttemptWindowStart": "2026-01-01T00:00:00.000Z",
"LastLockoutDate": "2026-01-01T00:00:00.000Z",
"LastLoggedIn": "2026-01-01T00:00:00.000Z",
"CrossTenantCollections": "text",
"PinCode": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Photo": "text",
"Notes": "text",
"ManagerUserId": "text",
"Gender": "text",
"JobTitle": "text",
"EmployeeId": "text",
"FacilityId": "text",
"SecondaryFacilityIds": [
"text"
],
"ETag": "text",
"Tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"CustomFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Tenant Var Code
Username
Tenant Var Code
The email address that is used as login
A unique identifier of the user
User's password (used for POST, PUT and PATCH only)
The first name of the user
The last name of the user
The unique identifier for the user role
A boolean indicating whether user verified his email
A boolean indicating if account is disabled
A boolean indicating if account is enabled for the portal
A number of invalid login attempts in last time window
A date and time of last invalid login time window start
A date and time when the account was locked because of too many invalid login attempts
A date and time when the user logged in last time
String with comma delimited list of cross tenant collection IDs which are assigned to the user
Pin code for external services
Timestamp (UTC) indicating version of record being returned
Base64 encoded user profile photo. Included in GET request only when photo parameter is specified.
Free form notes that can be added against a user.
User's manager unique identifier
Valid options are Male, Female, Transgender, Non-Binary, Other
Users job title
Users employee Id
User's primary facility ID
List of secondary facility IDs
ETag representing record version
OK
No content
PUT /V2/{tenantVarCode}/users/{username} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 722
{
"TenantCode": "text",
"Username": "text",
"UserId": "text",
"Password": "text",
"FirstName": "text",
"LastName": "text",
"UserRoleId": "text",
"IsApproved": true,
"IsDisabled": true,
"IsPortalEnabled": true,
"FailedPasswordAttemptCount": 1,
"FailedPasswordAttemptWindowStart": "2026-01-01T00:00:00.000Z",
"LastLockoutDate": "2026-01-01T00:00:00.000Z",
"LastLoggedIn": "2026-01-01T00:00:00.000Z",
"CrossTenantCollections": "text",
"PinCode": "text",
"Timestamp": "2026-01-01T00:00:00.000Z",
"Photo": "text",
"Notes": "text",
"ManagerUserId": "text",
"Gender": "text",
"JobTitle": "text",
"EmployeeId": "text",
"FacilityId": "text",
"SecondaryFacilityIds": [
"text"
],
"ETag": "text",
"Tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"CustomFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}OK
No content
OK
No content
PATCH /V2/{tenantVarCode}/users/{username} HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 56
[
{
"value": null,
"path": "text",
"op": "text",
"from": "text"
}
]OK
No content
Last updated