VX Agents

API directory · Productivity & Project Management

Jira Software Boards & Sprints

v1.0.0 · 17 endpoints · 0 connections · shared by vx.ai

When sprint planning comes around, list a Jira Software board's sprints, epics and versions, create the next sprint, set its goal and dates, pull ranked issues in from the backlog with story-point estimates, then start or close it.

Connect this API to an AI agent Browse all specs

What you can do with Jira Software Boards & Sprints via MCP

Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.

MethodPathOperationDescription
GET /rest/agile/1.0/board listBoards List Scrum and Kanban boards, optionally by project or name
GET /rest/agile/1.0/board/{boardId} getBoard Get a board's name, type and project
GET /rest/agile/1.0/board/{boardId}/configuration getBoardConfiguration Get a board's columns, estimation field and filter
GET /rest/agile/1.0/board/{boardId}/sprint listSprints List a board's sprints by state (future, active, closed)
GET /rest/agile/1.0/sprint/{sprintId} getSprint Get a sprint's state, goal and dates
POST /rest/agile/1.0/sprint/{sprintId} updateSprint Change a sprint's name, goal or dates, or start or close it
POST /rest/agile/1.0/sprint createSprint Create a future sprint on a board
POST /rest/agile/1.0/sprint/{sprintId}/issue moveIssuesToSprint Move up to 50 issues into a sprint
POST /rest/agile/1.0/backlog/issue moveIssuesToBacklog Move issues out of sprints back to the backlog
PUT /rest/agile/1.0/issue/rank rankIssues Rank issues before or after another issue
GET /rest/agile/1.0/board/{boardId}/epic listBoardEpics List the epics on a board
GET /rest/agile/1.0/board/{boardId}/version listBoardVersions List release versions for a board's projects
GET /rest/agile/1.0/board/{boardId}/quickfilter listQuickFilters List a board's quick filters and their JQL
GET /rest/agile/1.0/board/{boardId}/project listBoardProjects List the projects a board covers
GET /rest/agile/1.0/issue/{issueIdOrKey} getAgileIssue Get an issue with its sprint, epic and rank fields
GET /rest/agile/1.0/issue/{issueIdOrKey}/estimation getIssueEstimation Get an issue's estimate (story points) on a board
PUT /rest/agile/1.0/issue/{issueIdOrKey}/estimation setIssueEstimation Set an issue's estimate (story points) on a board

Authentication

jiraBasic

HTTP Basic

How to get a credential

  1. Sign in at id.atlassian.com → Security → Create and manage API tokens.
  2. Click Create API token, name it, pick an expiry, and copy it.
  3. Use your Atlassian account email as the username and the API token as the password.
  4. Set the server URL to your site, https://<site>.atlassian.net.

Permissions used

The token acts as you, so you need access to the board and project. For an OAuth 2.0 (3LO) app the matching scopes are:

Scope Operations
read:board-scope:jira-software listBoards, getBoard, listBoardVersions
read:board-scope.admin:jira-software getBoardConfiguration, listQuickFilters, listBoardProjects
read:sprint:jira-software listSprints, getSprint
write:sprint:jira-software createSprint, updateSprint, moveIssuesToSprint
write:board-scope:jira-software moveIssuesToBacklog
read:epic:jira-software listBoardEpics
read:issue:jira-software getAgileIssue, getIssueEstimation
write:issue:jira-software setIssueEstimation, rankIssues

Common errors

  • 401 Unauthorized: wrong email/token pair, or the token expired.
  • 403 Forbidden: you lack project permissions such as Manage sprints, Schedule issues or Edit issues.
  • 400 Bad Request: invalid sprint state change (for example starting a sprint without startDate and endDate), or more than 50 issues in one move.
  • 404 Not Found: wrong site, board, sprint or issue key, or you cannot see it.
  • 429 Too Many Requests: wait for Retry-After.

Store the email and token as a VX Agents basic auth credential.

Usage guide

Setup

  • Credential: Atlassian account email + API token (basic auth).
  • Server URL: set site to your Atlassian site, so requests go to https://<site>.atlassian.net.
  • Worth pinning: the boardId of your team's Scrum board (from listBoards with projectKeyOrId, or the board URL .../boards/<id>).

Plan the next sprint

  1. listSprints with state=active,future to see the current and upcoming sprints; getSprint for goal and dates.
  2. createSprint with name and originBoardId (optional goal, startDate, endDate) if the next sprint does not exist yet.
  3. Find candidate issues with the Jira Issues spec (JQL such as project = ABC AND sprint is EMPTY AND statusCategory != Done ORDER BY Rank); this spec does not search issues.
  4. getIssueEstimation / setIssueEstimation (with boardId and value) to read or set story points.
  5. moveIssuesToSprint with up to 50 issues keys per call; rankAfterIssue or rankBeforeIssue sets their order. rankIssues reorders without moving; moveIssuesToBacklog takes issues out of all sprints.
  6. Start: updateSprint with state=active (the sprint must be future and have startDate and endDate). Close: updateSprint with state=closed on the active sprint.

Before creating, starting or closing a sprint, or moving, ranking or re-estimating issues, show the change to the user and get a yes: it changes the whole team's board.

Board context

  • getBoardConfiguration: columns, the estimation field and the board's filter.
  • listBoardEpics (done=false for open ones), listBoardVersions (released=false), listQuickFilters (their JQL), listBoardProjects.
  • getAgileIssue returns an issue with its sprint, closedSprints, epic and rank fields.

Good to know

  • Dates are ISO 8601 with offset (2026-10-20T09:00:00.000+02:00).
  • Lists page with startAt and maxResults; check isLast before asking for more.
  • Closed sprints only accept name and goal changes; completeDate cannot be set by hand.
  • Kanban boards have no sprints.

Source: Jira Software Cloud REST API reference (https://developer.atlassian.com/cloud/jira/software/rest/intro/), checked 2026-10-19.

How to use this spec

  1. Create a free VX Agents account (sandbox tools included).
  2. Open the marketplace and connect “Jira Software Boards & Sprints” to an agent.
  3. Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.

Related APIs

  • Notion Pages & Databases — Before stand-up, pull this week's open tasks from a Notion data source with filters and sorts, read the spec page behin…
  • Jira Issues — Lets an agent work Jira Cloud issues: search with JQL, read issues and comments, create and edit issues, assign them, c…
  • Smartsheet Sheets & Rows — For teams that run projects in Smartsheet: find a sheet, read its rows and columns, add or update rows by column id, an…
  • Asana Tasks & Projects — Lets an agent work in Asana: find workspaces, projects, sections and people, search and read tasks with their comments,…
  • Confluence Pages — Find, read and write Confluence Cloud pages: browse spaces, look up pages by title or space, read page bodies, walk the…
  • Trello Boards & Cards — Lets an agent work on Trello boards: list your boards, read lists, cards, labels and members, search cards, create and …