In this guide, you will learn how to retrieve the status list for an idea board.
Example
Retrieve the Status List for a Board
In this example, you will retrieve the status list for an idea board, which will provide you with the status of the idea, the group key, label color, and label description.
{
board(id:"board:idea1") {
... on Idea {
ideaStatusGroups {
groups {
groupKey
statuses {
statusKey
statusGroupKey
text
description
label {
visible
type
color
}
isDeleted
}
}
}
}
}
}
The response for this GraphQL call looks like:
{
"data": {
"board": {
"ideaStatusGroups": {
"groups": [
{
"groupKey": "new",
"statuses": [
{
"statusKey": "unspecified",
"statusGroupKey": "new",
"text": "Unspecified",
"description": "Status with no label",
"label": {
"visible": false,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
},
{
"groupKey": "in_progress",
"statuses": [
{
"statusKey": "future_consideration",
"statusGroupKey": "in_progress",
"text": "Future Consideration",
"description": "Idea has been accepted by the team but is considered for future implementation",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "in_review",
"statusGroupKey": "in_progress",
"text": "In Review",
"description": "Idea is being investigated and scoped by the team",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "dsc",
"statusGroupKey": "in_progress",
"text": "sdc",
"description": "",
"label": {
"visible": true,
"type": "FILLED",
"color": "0069D4"
},
"isDeleted": false
},
{
"statusKey": "needs_info",
"statusGroupKey": "in_progress",
"text": "Needs Info",
"description": "More information is needed from the author of this idea",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
},
{
"groupKey": "on_hold",
"statuses": [
{
"statusKey": "accepted",
"statusGroupKey": "on_hold",
"text": "Accepted",
"description": "Idea has been accepted by the team",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
},
{
"groupKey": "completed",
"statuses": [
{
"statusKey": "delivered",
"statusGroupKey": "completed",
"text": "Delivered",
"description": "Idea has been completed and delivered to customers",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "new",
"statusGroupKey": "completed",
"text": "New",
"description": "Newly submitted idea awaiting team review",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
},
{
"groupKey": "closed",
"statuses": [
{
"statusKey": "declined",
"statusGroupKey": "closed",
"text": "Declined",
"description": "Idea has been rejected by the team",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "already_exists",
"statusGroupKey": "closed",
"text": "Already Exists",
"description": "Similar idea has already been submitted or delivered",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
}
]
}
}
}
}
Retrieve the Status List Including Deleted Statuses for a Board
In this example, you will retrieve the status list for an idea board including the deleted statuses. Based on this, you will know the status of the idea, the group key, label color, and label description.
{
board(id:"board:idea1") {
... on Idea {
ideaStatusGroups (showDeletedStatuses: true) {
groups {
groupKey
statuses {
statusKey
statusGroupKey
text
description
label {
visible
type
color
}
isDeleted
}
}
}
}
}
}
Here is the response for the GraphQL call looks like:
{
"data": {
"board": {
"ideaStatusGroups": {
"groups": [
{
"groupKey": "new",
"statuses": [
{
"statusKey": "unspecified",
"statusGroupKey": "new",
"text": "Unspecified",
"description": "Status with no label",
"label": {
"visible": false,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
},
{
"groupKey": "in_progress",
"statuses": [
{
"statusKey": "future_consideration",
"statusGroupKey": "in_progress",
"text": "Future Consideration",
"description": "Idea has been accepted by the team but is considered for future implementation",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "in_review",
"statusGroupKey": "in_progress",
"text": "In Review",
"description": "Idea is being investigated and scoped by the team",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "dsc",
"statusGroupKey": "in_progress",
"text": "sdc",
"description": "",
"label": {
"visible": true,
"type": "FILLED",
"color": "0069D4"
},
"isDeleted": false
},
{
"statusKey": "needs_info",
"statusGroupKey": "in_progress",
"text": "Needs Info",
"description": "More information is needed from the author of this idea",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "test_status",
"statusGroupKey": "in_progress",
"text": "Test Status",
"description": null,
"label": {
"visible": true,
"type": "OUTLINE",
"color": "5b325c"
},
"isDeleted": true
}
]
},
{
"groupKey": "on_hold",
"statuses": [
{
"statusKey": "accepted",
"statusGroupKey": "on_hold",
"text": "Accepted",
"description": "Idea has been accepted by the team",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
},
{
"groupKey": "completed",
"statuses": [
{
"statusKey": "delivered",
"statusGroupKey": "completed",
"text": "Delivered",
"description": "Idea has been completed and delivered to customers",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "new",
"statusGroupKey": "completed",
"text": "New",
"description": "Newly submitted idea awaiting team review",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
},
{
"groupKey": "closed",
"statuses": [
{
"statusKey": "declined",
"statusGroupKey": "closed",
"text": "Declined",
"description": "Idea has been rejected by the team",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
},
{
"statusKey": "already_exists",
"statusGroupKey": "closed",
"text": "Already Exists",
"description": "Similar idea has already been submitted or delivered",
"label": {
"visible": true,
"type": "OUTLINE",
"color": "000000"
},
"isDeleted": false
}
]
}
]
}
}
}
}
ATLAS
Comments