AuditDashboard Developer Portal
  1. Users
AuditDashboard Developer Portal
  • AuditDashboard Developer Portal
  • Clients
    • Get All Clients
      GET
    • Create Clients
      POST
    • Update Clients
      PUT
    • Deactivate Clients
      DELETE
    • Activate Clients
      PATCH
    • Client Details
      GET
    • Update Client
      PUT
    • Deactivate Client
      DELETE
    • Activate Client
      PATCH
  • Divisions
    • Get Active Divisions
      GET
  • Engagements
    • Get Engagements by Status
      GET
    • Create Engagements
      POST
    • Update Engagement
      PUT
    • Update Engagement Statuses
      PATCH
    • Delete Engagements
      DELETE
    • Get Engagement Details
      GET
    • Update Engagement
      PUT
    • Update Engagement Status
      PATCH
    • Delete Engagement
      DELETE
    • Download Engagement Documents
      GET
    • Download Engagement Request Report
      GET
    • Download 'All Engagements' Report
      GET
  • Insights
    • Get Engagement Activity Log Parameters
    • Engagement Activity Log
    • Get Engagement by Last Activity Report Parameters
    • Engagement by Last Activity
    • Get Active Professional Users for Schedule
    • Schedule
    • User Activity and Status
  • Requests
    • Get Engagement Requests
    • Get Request by ID
    • Update Request Details
    • Update Request Status and Priority
    • Delete Request
    • Create Requests
    • Update Multiple Requests
    • Update Request Status and Priority
    • Delete Multiple Requests
    • Get Request History Feed
    • Get Request Activity Feed
    • Add Comment to Request
    • Delete a Request Comment
    • Delete a Request Document
    • Download Request Documents
    • Update Multiple Request Restrictions
    • Update Single Request Restrictions
    • Upload Request Document
  • Users
    • Get Users by Status
      GET
    • Create Users
      POST
    • Update Multiple Users
      PUT
    • Deactivate Users
      DELETE
    • Activate Users
      PATCH
    • Get User Details
      GET
    • Update User Details
      PUT
    • Deactivate User
      DELETE
    • Activate User
      PATCH
    • Invite Users
      POST
    • Generate User Activity Report
      POST
  • Authorization
    • Authorization call for Bearer Token
  • Trash
    • Get Trash Types
    • Get Trash List
    • Restore Trash Items
    • Permanently deletes trash items.
    • Restore a Trash Item
    • Permanently deletes a trash item.
  1. Users

Get User Details

GET
/api/public/users/{userID}
Users
Retrieves detailed information about a specific user by their unique ID.

Request

Path Params
userID
integer <int32>
required
The unique identifier of the user to retrieve.

Responses

🟢200OK
text/plain
Success: Returns detailed user information.
Body
UserID
integer <int32>
optional
IsClient
boolean 
optional
Is the user a professioanl or client? Set to true for client user, false for professioanl. Professional users consume licenses and have different workflows from clients.
FirstName
string  | null 
optional
The user's first name (maximum 100 characters).
LastName
string  | null 
optional
The user's last name (maximum 100 characters).
Email
string  | null 
optional
The user's email address (must be unique).
Phone
string  | null 
optional
Phone (maximum 25 characters)
Mobile
string  | null 
optional
Mobile (maximum 25 characters)
Fax
string  | null 
optional
Fax (maximum 25 characters)
Title
string  | null 
optional
Titles (maximum 100 characters)
HomeOffice
string  | null 
optional
Home Office (maximum 100 characters)
DisableContactSharing
boolean  | null 
optional
Divisions: Only needed for professional users. Main is always ID 1000
SummaryEmailFrequency
enum<integer> <int32>
optional
Allowed values:
012
EngagementChangeEmailType
enum<integer> <int32>
optional
Allowed values:
0116383
RequestChangeEmailType
enum<integer> <int32>
optional
Allowed values:
0124816383
MFAType
enum<integer> <int32>
optional
Allowed values:
01248
Status
enum<integer> <int32>
optional
Allowed values:
0124-32768
Created
object (TrackingInfo) 
optional
By
integer <int32>
optional
On
string <date-time>
optional
Modified
object (TrackingInfo) 
optional
Engagements
array[integer <int32>] | null 
optional
Divisions
array[integer <int32>] | null 
optional
List of DivisionIDs the user belongs to
Companies
array[integer <int32>] | null 
optional
List of CompanyIDs the user belongs to
Offices
array[integer <int32>] | null 
optional
List of OfficeIDs the user belongs to
Roles
array[integer <int32>] | null 
optional
Roles: Each user must be assigned at least one Global Role. General will be assigned if this is not provided.
Professional Roles
1000 - Administrator: Full system access.
1020 - Staff Manager: Add or remove users from the system.
1030 - Engagement Admin: Create, manage, and delete all engagements.
1035 - Engagement Manager: Manage engagements they are a part of.
Client Roles
1010 - Client Manager: Manage client companies and users.
Professioanl or Client Roles
1049 - General: Read engagements and respond to requests.
Example
{
  "UserID": 0,
  "IsClient": true,
  "FirstName": "string",
  "LastName": "string",
  "Email": "string",
  "Phone": "string",
  "Mobile": "string",
  "Fax": "string",
  "Title": "string",
  "HomeOffice": "string",
  "DisableContactSharing": true,
  "SummaryEmailFrequency": 0,
  "EngagementChangeEmailType": 0,
  "RequestChangeEmailType": 0,
  "MFAType": 0,
  "Status": 0,
  "Created": {
    "By": 0,
    "On": "2019-08-24T14:15:22Z"
  },
  "Modified": {
    "By": 0,
    "On": "2019-08-24T14:15:22Z"
  },
  "Engagements": [
    0
  ],
  "Divisions": [
    0
  ],
  "Companies": [
    0
  ],
  "Offices": [
    0
  ],
  "Roles": [
    0
  ]
}
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Modified at 2025-03-24 12:24:39
Previous
Activate Users
Next
Update User Details
Built with