List Sprints

jira.list_sprints

ActionBusiness appsconnection required

Calls the Jira Cloud REST API with the connection's email and API token.

List the sprints on a Jira Software board.

Ask about Jira All Jira nodes Provider API docs ↗

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

4 fields, 1 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
board_id The board's numeric id — list boards with jira.list_boards.	string	Yes	—	—	10021
state Only sprints in these states; comma-separate to combine, e.g. 'active,future'.	string	No	—	—	—
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.

{
  "board_id": "10021",
  "max_results": 50,
  "start_at": 0
}

Output

One shape.

result

Field	Type	Example
sprints[].id The sprint id.	number	—
sprints[].name The sprint's name.	string	—
sprints[].state 'future', 'active' or 'closed'.	string	—
sprints[].startDate When the sprint starts, ISO-8601.	string	—
sprints[].endDate When the sprint ends, ISO-8601.	string	—
sprints[].goal The sprint goal, when one is set.	string	—
sprints[].originBoardId The board the sprint was created on.	number	—
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	—

{
  "count": 0,
  "is_last": false,
  "sprints": [
    {
      "endDate": "",
      "goal": "",
      "id": 0,
      "name": "",
      "originBoardId": 0,
      "startDate": "",
      "state": ""
    }
  ],
  "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.
Only scrum boards have sprints; a kanban board returns none.

Related Jira nodes

Templates that use Jira

Solutions with Jira

See List Sprints 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.

Book a technical demo Talk to sales