Powered by Redocly

Users

Retrieve user information by id

SecurityOAuth2
Request
path Parameters
id
required
string (User identifier)
Example: 6295dcd39db1ab740c3e296c
Responses
200

Successful Response

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/users/{id}
Request samples 
Response samples 
application/json
{
  • "id": "660572bc7a3cd6803f112252",
  • "email": "firstname.lastname@company.inc",
  • "name": "Firstname Lastname",
  • "companiesAccess": [
    ],
  • "active": true,
  • "isInternal": false
}
Retrieve a users list for given search criteria
SecurityOAuth2 
Request 
query Parameters
search
string (Search text used to find users.) 
 
active
boolean (Is active flag used to filter users.) 
 
roles
Array of strings (User roles used to filter on.) 
Items Enum: "installationAdmin" "installationClerk" "admin" "clerk" "manager" "supportSpecialist"  
limit
integer (The limit used for this page of results.)   >= 0 
 Default:  20
 
offset
integer (The offset used for this page of results.)   >= 0 
 Default:  0
 
Responses 
200
Successful Response


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


get/users
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "totalCount": 0,
  • "limit": 0,
  • "offset": 0
}