API Reference

Gets the dashboard definition for a specific employee.

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

Access: System, Admin, ClientAdmin, and Employee users.

The route identifies both the company and employee context for the dashboard that should be resolved.

When includeData is true, each widget includes its widget-specific payload. When it is false, the response only includes dashboard metadata such as ordering and visibility.

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

Company identifier that owns the employee dashboard.

int32
required

Employee 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 1 month ago

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 1 month ago