API Reference

Gets the dashboard definition for a specific company.

get
https://example.com/wep/companies//dashboard

Access: System, Admin, and ClientAdmin users only.

The companyId route value is validated before the dashboard is loaded so the request is always tied to an existing company context.

When includeData is true, each widget includes its widget-specific payload. When it is false, the response only includes dashboard metadata. Company dashboards may also include blocked-company status information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier whose dashboard should be returned.

Query Params
boolean
Defaults to true

true to include widget-specific payloads; otherwise only dashboard metadata is returned.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain

Updated about 2 months ago

Did this page help you?