---
title: "Get dashboard content"
method: GET
path: "/v1/objects/{object-id}/dashboard"
tags: ["Objects"]
---

# Get dashboard content

`GET /v1/objects/{object-id}/dashboard`

Return the content of a dashboard or dashboard template object: the column count,
display priority, and the element (widget) layout. Requires read access. Applies only
to objects of class `Dashboard` or `DashboardTemplate`.

## Path parameters

- `object-id` integer, required

## Response `200`

Dashboard content.

- DashboardContent — Content of a dashboard or dashboard template object - column count, display priority, and element layout.
  - `numColumns` integer — Number of layout columns.
  - `displayPriority` integer — Display ordering priority (plain dashboards only; ignored for templates).
  - `forcedContextObjectId` integer — Forced context object ID for dashboards created from a template (plain dashboards only; ignored for templates).
  - `elements` DashboardElement[] — Dashboard elements. On update this is a full replacement of the element layout.
    - `guid` string, uuid — Element GUID. Assigned by the server when omitted on input.
    - `type` integer, required — Element type code.
    - `data` object — Element configuration (type-specific free-form object).
    - `layout` object — Element layout / placement (free-form object).

## Other responses

- `400` — Object is not a dashboard or dashboard template
- `401` — Unauthorized
- `403` — User does not have read access to the object
- `404` — Object with given ID does not exist

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/14d93e5115dd/schema)