AuditDashboard Developer Portal
  1. Clients
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
      GET
    • Engagement Activity Log
      POST
    • Get Engagement by Last Activity Report Parameters
      GET
    • Engagement by Last Activity
      POST
    • Get Active Professional Users for Schedule
      GET
    • Schedule
      POST
    • User Activity and Status
      POST
  • 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
    • Create Users
    • Update Multiple Users
    • Deactivate Users
    • Activate Users
    • Get User Details
    • Update User Details
    • Deactivate User
    • Activate User
    • Invite Users
    • Generate User Activity Report
  • 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. Clients

Get All Clients

GET
/api/public/clients
Clients
Retrieves a list of APICompanyModel objects of client companies.
Note: UserIDs are not returned in this call.

Request

None

Responses

🟢200OK
text/plain
Success: Returns the list of client companies and their offices, and any divisions they are associated with.
Body
array of:
CompanyID
integer <int32>
optional
Gets the unique identifier for the company.
CompanyName
string  | null 
optional
Gets the name of the company (maximum 100 characters).
HeadOfficeID
integer <int32>
optional
Gets the identifier for the head office of the company.
AuthTypes
enum<integer> <int32>
optional
Allowed values:
0141648801283846402147483647
AuthIssuers
string  | null 
optional
Gets the authentication issuers for the company.
Address
string  | null 
optional
Gets the address of the company (maximum 100 characters).
City
string  | null 
optional
Gets the city where the company is located (maximum 100 characters).
Province
string  | null 
optional
Gets the province / region where the company is located (maximum 100 characters).
PostalCode
string  | null 
optional
Gets the postal code for the company address (maximum 10 characters).
Country
string  | null 
optional
Gets the country where the company is located (maximum 100 characters).
Phone
string  | null 
optional
Gets the phone number of the company (maximum 25 characters).
Fax
string  | null 
optional
Gets the fax number of the company (maximum 25 characters).
Website
string  | null 
optional
Gets the website URL of the company (maximum 500 characters).
Industry
string  | null 
optional
Gets the industry sector of the company (maximum 100 characters).
RequiresMFA
boolean  | null 
optional
Gets a value indicating whether the company requires multi-factor authentication.
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
Divisions
array[integer <int32>] | null 
optional
Gets the list of division IDs associated with the company.
Users
array[integer <int32>] | null 
optional
Gets the list of user IDs associated with the company.
Offices
array[integer <int32>] | null 
optional
Gets the list of office IDs associated with the company.
Example
[
  {
    "CompanyID": 0,
    "CompanyName": "string",
    "HeadOfficeID": 0,
    "AuthTypes": 0,
    "AuthIssuers": "string",
    "Address": "string",
    "City": "string",
    "Province": "string",
    "PostalCode": "string",
    "Country": "string",
    "Phone": "string",
    "Fax": "string",
    "Website": "string",
    "Industry": "string",
    "RequiresMFA": true,
    "Status": 0,
    "Created": {
      "By": 0,
      "On": "2019-08-24T14:15:22Z"
    },
    "Modified": {
      "By": 0,
      "On": "2019-08-24T14:15:22Z"
    },
    "Divisions": [
      0
    ],
    "Users": [
      0
    ],
    "Offices": [
      0
    ]
  }
]
🟠401Unauthorized
Modified at 2025-03-24 12:24:39
Previous
AuditDashboard Developer Portal
Next
Create Clients
Built with