The Teamwork Graph API is available through Forge's Early Access Program (EAP).
EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.
You must only install apps that call the Teamwork Graph API in test organizations. Apps calling
the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph
data across your entire organization. While apps still respect end-user permissions, this scope may
grant access to sensitive information. For safety, only install these apps in organizations with test
data. Do not install apps using this API in organizations with production data while this feature is in EAP.
Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.
You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.
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 source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Jira space has Jira board | Jira board | Jira space |
Rate this page: