List Boards
jira.list_boards
ActionBusiness appsconnection required
Calls the Jira Cloud REST API with the connection's email and API token.
List the Jira Software boards the connection can see.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Jira
- Secret shape
- {"email", "api_token"}
- Config it needs
- domain
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
project_key Only boards whose location is this project key or id. | string | No | — | — | — |
name Only boards whose name contains this text. | string | No | — | — | — |
board_type Only boards of this type. | string | No | — | one of "scrum", "kanban", "simple" | — |
start_at Index of the first result to return, for paging through a long list. | number | No | 0 | ≥ 0 | — |
max_results Maximum results to return in one call. | number | No | 50 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_results": 50,
"start_at": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
boards[].id The board id, used by the sprint and backlog ops. | number | — |
boards[].name The board's name. | string | — |
boards[].type 'scrum', 'kanban' or 'simple'. | string | — |
boards[].location.projectKey The project the board belongs to. | string | — |
count How many items this call returned. | number | — |
total How many items match in total, when Jira reports one. | number | — |
start_at Index of the first item in this page. | number | — |
is_last True when this is the final page of results. | boolean | — |
{
"boards": [
{
"id": 0,
"location": {
"projectKey": ""
},
"name": "",
"type": ""
}
],
"count": 0,
"is_last": false,
"start_at": 0,
"total": 0
}Notes
- Boards, sprints and the backlog are Jira Software's API (/rest/agile/1.0), not the platform API — they exist only on a site with Jira Software, and only company-managed and team-managed software projects have boards.
See List Boards run in a workflow.
In a technical demo we add the Jira connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.