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 the status of a Jira work item indicating its current state in the workflow. Work item statuses track work progress through defined states like "To Do", "In Progress", or "Done".
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 work item status.
| Field | Type | Description |
|---|---|---|
description | String | Optional description of the status. |
id | ID! | Unique identifier for the status. This ID is globally unique across the entire Teamwork Graph. |
name | String | Name of status. E.g. Backlog, Selected for Development, In Progress, Done. |
statusCategory | JiraStatusCategory | Represents a group of Jira statuses. |
statusId | ID | Status id in the digital format. |
| Field | Type | Description |
|---|---|---|
colorName | JiraStatusCategoryColor | Color of status category. |
id | ID! | Global identifier for the Status Category. |
key | String | A unique key to identify this status category. E.g. new, indeterminate, done. |
name | String | Name of status category. E.g. New, In Progress, Complete. |
statusCategoryId | ID | Status category id in the digital format. |
| Value | Description |
|---|---|
BLUE_GRAY | Blue gray color. |
BROWN | Brown color. |
GREEN | Green color. |
MEDIUM_GRAY | Medium gray color. |
WARM_RED | Warm red color. |
YELLOW | Yellow color. |
The following relationships are currently supported for Jira work item status:
Relationships where Jira work item status is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Jira work item has changed Jira status | Jira work item | Jira work item status |
Rate this page: