Back to TeamworkGet all dashboards
Return all dashboards that the logged-in user can access. Dashboards contains
panels that are used to summarize many activities from the installation.
Input
type: object
properties:
parameters:
type: object
properties:
updatedAfter:
type: string
format: date-time
description: filter by updated after date
orderMode:
type: string
enum:
- asc
- desc
default: asc
description: order mode
orderBy:
type: string
enum:
- isDefault
- displayOrder
default: isDefault
description: order by
userId:
type: integer
description: filter by user id
projectId:
type: integer
description: filter by project id
pageSize:
type: integer
default: '50'
description: number of items in a page
page:
type: integer
default: '1'
description: page number
showDeleted:
type: boolean
default: 'false'
description: include deleted items
emoji:
type: boolean
default: 'true'
description: parse emoji alias to unicode
include:
type: array
items:
enum:
- projects
- users
- dashboardSettings
- dashboardPanels
- dashboardPanels.settings
type: string
description: include
fields[users]:
type: array
items:
enum:
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
type: string
fields[projects]:
type: array
items:
enum:
- id
- name
type: string
fields[dashboards]:
type: array
items:
enum:
- id
- title
- color
- description
- isDefault
- userId
- projectId
- displayOrder
- deleted
- dateCreated
- dateUpdated
- dateDeleted
- dashboardPanelIds
- dashboardSettingIds
type: string
fields[dashboardSettings]:
type: array
items:
enum:
- id
- dashboardId
- name
- value
type: string
fields[dashboardPanels]:
type: array
items:
enum:
- id
- dashboardId
- name
- type
- displayOrder
- dashboardPanelSettingIds
type: string
fields[dashboardPanelSettings]:
type: array
items:
enum:
- id
- installationId
- dashboardId
- dashboardPanelId
- name
- value
type: string
dashboardIds:
type: array
items:
type: integer
description: filter by user dashboard ids
title: Parameters
Output
type: object
title: UserDashboardsResponse
properties:
dashboards:
type: array
items:
type: object
title: UserDashboard
properties:
color:
type: string
createdAt:
type: string
dashboardPanelIds:
type: array
items:
type: integer
dashboardPanels:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
dashboardSettingIds:
type: array
items:
type: integer
dashboardSettings:
type: array
items:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
deleted:
type: boolean
deletedAt:
type: string
description:
type: string
displayOrder:
type: integer
id:
type: integer
isDefault:
type: boolean
project:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
projectId:
type: integer
title:
type: string
updatedAt:
type: string
user:
type: object
title: Relationship
properties:
id:
type: integer
meta:
type: object
type:
type: string
userId:
type: integer
included:
type: object
properties:
dashboardPanelSettings:
type: object
dashboardPanels:
type: object
dashboardSettings:
type: object
projects:
type: object
users:
type: object
meta:
type: object
title: Meta
properties:
averageSpend:
type: integer
limit:
type: integer
nextCursor:
type: string
page:
type: object
title: MetaPage
properties:
count:
type: integer
hasMore:
type: boolean
pageOffset:
type: integer
pageSize:
type: integer
prevCursor:
type: string
totalCapacity:
type: integer