v1
latestOpenAPI 3.0.02026-07-12152226.1 KBDashboards
listDashboards
List dashboards available to the user
get/v1/dashboard/dashboards
Query parameters
qstring
Free-text search over name/title and description (case-insensitive substring).
created_bystring
Filter by the id of the creating user.
created_afterstring date-time
created_beforestring date-time
updated_afterstring date-time
updated_beforestring date-time
shared_withstring[]
Filter to resources shared with any of the given user ids.
ownerstring[]
Filter to resources owned by any of the given user ids.
accessible_tostring
Filter to resources the given user id may view (owner, shared, org-wide or legacy).
sort'created_at' | 'updated_at' | 'name' | 'title'
Field to sort by. name applies to insights, title to dashboards.
order'asc' | 'desc'
Sort direction. Defaults to ascending (preserving the pre-migration order).
limitinteger
Maximum results to return (max 200). Omit to return all matching results (pagination is opt-in).
offsetinteger
Number of results to skip, for pagination. Use with limit (page N = offset N*limit).
Response
List of dashboards available to the user
Example response
{
"results": [
{
"created_by": "10598",
"updated_by": "10598",
"owner_org_id": "739224",
"owners": [
"10598"
],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "Employee Dashboard",
"tiles": [
{
"id": "e4af1297-1fd6-440f-9846-f475f580d40f",
"coordinates": {},
"insight_id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e"
}
]
}
]
}