Get

[POST] .../v1/userdashboard/get

Returns dashboards assigned to a user. Use this method to list dashboard assignments for the current user or for another user before rendering dashboard navigation or changing default dashboard settings. The response returns UserDashboard records with the assignment id, resolved user_id, dashboard header, default assignment flag and creator flag; filters can select user_id and dashboard_id, user_id is optional and when omitted or 0 the server uses the current request user, while dashboard_id can narrow the result. The caller must have the user-dashboard get permission and dashboard rows are limited to non-deleted dashboards assigned to the selected user. Business errors such as missing body, denied permission, negative user_id, missing current user context, database errors and persistent lookup failures are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
dashboard_id int Dashboard IDs. Omit to return every dashboard assigned to the selected user.
user_id int User ID. If omitted or 0, the current request user is used.

Request Example

{
  "filters": [
    {
      "Field": "user_id",
      "Operator": "Equal",
      "Value": "0"
    },
    {
      "Field": "dashboard_id",
      "Operator": "In",
      "Value": "3"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of UserDashboard Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 22,
      "user_id": 15,
      "dashboard": {
        "id": 3,
        "period": "Week",
        "name": "Sales overview",
        "firm_id": 10,
        "stock_id": 4,
        "is_fixed": false,
        "is_default": true,
        "is_creator": true,
        "last_update": 1712345600
      }
    }
  ]
}