The Teamwork Graph API is available through Forge's Preview release phase.
Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.
To review the current limitations, see Limitations and considerations.
To share feedback or report an issue, visit the Atlassian developer community.
Represents a Jira board used for visualizing and managing work in Scrum or Kanban workflows. Boards provide visual interfaces for tracking issue progress and team workflow management.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Jira board.
| Field | Type | Description |
|---|---|---|
boardFrontendUrl | URL | The frontend URL for accessing this board in the Jira UI. |
boardType | JiraBoardType | Type of the board (KANBAN or SCRUM). |
boardUrl | URL | The URL string associated with a board in Jira. |
canEdit | Boolean | Whether a user has permission to edit the board settings. |
iconUrl | URL | The URL for the icon representing this board (for example, the associated project icon). |
id | ID! | Unique identifier for the board. This ID is globally unique across the entire Teamwork Graph. |
lastViewedTimestamp | Long | The timestamp of this board was last viewed by the current user (reference to Unix Epoch time in ms). |
name | String | The title/name of the board. |
| Value | Description |
|---|---|
KANBAN | Kanban board type. |
SCRUM | Scrum board type. |
The following relationships are currently supported for Jira board:
Relationships where Jira board is the target object.
Rate this page: