Operations 33
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which Jira boards do I have permission to view?”
“Can I filter boards to only scrum or only kanban ones?”
Tell an agent
List all the boards I can view.
List {type} boards whose name contains {name}.
Ask an LLM
“How do I create a new scrum board from a saved filter?”
“What do I need to supply to set up a kanban board in Jira?”
Tell an agent
Create a {type} board called {name} using filter {filterId}.
Set up a new kanban board named {name} based on saved filter {filterId}.
GET
/rest/agile/1.0/board/filter/{filterId}
Find boards that use a filter · Get board by filter id
#
Ask an LLM
“Which boards are built on a particular saved filter?”
“Can I check whether any board still depends on a filter before I change it?”
Tell an agent
Find every board that uses filter {filterId}.
Show me which boards are driven by saved filter {filterId}.
Ask an LLM
“Can I permanently remove a board I no longer use?”
“What happens when an admin deletes a board they can't view?”
Tell an agent destructive · confirm first
Delete board {boardId}.
Remove the unused board {boardId} from Jira.
Ask an LLM
“What are the name, type and location of a specific board?”
“Can I look up a single board by its ID?”
Tell an agent
Get the details of board {boardId}.
Show me board {boardId}'s type and location.
GET
/rest/agile/1.0/board/{boardId}/backlog
List backlog issues on a board · Get issues for backlog
#
Ask an LLM
“What issues are sitting in a board's backlog, not in any sprint?”
“Can I narrow a board's backlog with a JQL query using offset paging?”
Tell an agent
List the backlog issues for board {boardId}.
Show backlog issues on board {boardId} matching {jql}, starting at {startAt}.
GET
/rest/software/1.0/board/{boardId}/backlog
List backlog issues with token paging · Get issues for backlog (enhanced)
#
Ask an LLM
“Is there a backlog endpoint that pages with a nextPageToken instead of startAt?”
“Can I get a board's backlog with read-after-write reconciliation of recently edited issues?”
Tell an agent
List backlog issues for board {boardId} using the enhanced token-paged endpoint.
Fetch the next page of board {boardId}'s backlog with token {nextPageToken}.
GET
/rest/software/1.0/board/{boardId}/backlog/approximate-count
Count backlog issues on a board · Get approximate issue count for backlog
#
Ask an LLM
“Roughly how many issues are in a board's backlog?”
“Can I get an approximate backlog count without paging through every issue?”
Tell an agent
Estimate how many issues are in board {boardId}'s backlog.
Count backlog issues on board {boardId} that match {jql}.
Ask an LLM
“What columns, estimation field and filter does a board use?”
“How is a board's column-to-status mapping configured?”
Tell an agent
Get the configuration of board {boardId}.
Show me the columns and estimation settings for board {boardId}.
Ask an LLM
“Which epics appear on a given board?”
“Can I list only the epics that are not done yet on a board?”
Tell an agent
List the epics on board {boardId}.
Show epics on board {boardId} filtered by done status {done}.
GET
/rest/agile/1.0/board/{boardId}/epic/none/issue
List board issues with no epic · Get issues without epic for board
#
Ask an LLM
“Which issues on a board aren't assigned to any epic?”
“Can I find orphaned board issues without an epic using offset paging?”
Tell an agent
List issues on board {boardId} that don't belong to an epic.
Find epic-less issues on board {boardId} matching {jql}.
GET
/rest/software/1.0/board/{boardId}/epic/none/issue
List board issues with no epic, token paged · Get issues without epic for board (enhanced)
#
Ask an LLM
“Is there a token-paginated way to fetch board issues that have no epic?”
“Can I reconcile recently updated issues when listing ones without an epic?”
Tell an agent
Use the enhanced endpoint to list issues without an epic on board {boardId}.
Get the next page of no-epic issues on board {boardId} with token {nextPageToken}.
GET
/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue
List a board's issues in an epic · Get board issues for epic
#
Ask an LLM
“What issues belong to a specific epic on a board?”
“Can I see an epic's child issues on one board using startAt paging?”
Tell an agent
List issues in epic {epicId} on board {boardId}.
Show open work in epic {epicId} on board {boardId} matching {jql}.
GET
/rest/software/1.0/board/{boardId}/epic/{epicId}/issue
List a board's epic issues, token paged · Get board issues for epic (enhanced)
#
Ask an LLM
“Is there an enhanced, token-paged endpoint for an epic's issues on a board?”
“Can I page an epic's board issues with nextPageToken and reconcile fresh edits?”
Tell an agent
Use the enhanced endpoint to list issues in epic {epicId} on board {boardId}.
Fetch the next token page {nextPageToken} of epic {epicId} issues on board {boardId}.
Ask an LLM
“Which board features, like estimation or the backlog, are turned on for a board?”
“Can I check which features are enabled on a specific board?”
Tell an agent
List the features available on board {boardId}.
Show which features are enabled for board {boardId}.
Ask an LLM
“Can I enable or disable a feature on a board through the API?”
“What's needed to switch off a board feature programmatically?”
Tell an agent
Turn feature {feature} on or off for board {boardId}.
Set feature {feature} on board {boardId} to enabled={enabling}.
Ask an LLM
“Which issues are currently on a board's columns?”
“Can I list a board's issues with a JQL filter and offset paging?”
Tell an agent
List all issues on board {boardId}.
Show issues on board {boardId} matching {jql}, {maxResults} at a time.
POST
/rest/agile/1.0/board/{boardId}/issue
Move backlog issues onto a board · Move issues to board
#
Ask an LLM
“Can I move issues from the backlog onto a kanban board?”
“Is it possible to rank issues while moving them to the board?”
Tell an agent
Move issues {issues} from the backlog onto board {boardId}.
Move {issues} to board {boardId} and rank them after {rankAfterIssue}.
GET
/rest/software/1.0/board/{boardId}/issue
List board issues with token paging · Get issues for board (enhanced)
#
Ask an LLM
“Is there a token-based paginated version of listing all issues on a board?”
“Can I list board issues with reconcileIssues for read-after-write consistency?”
Tell an agent
Use the enhanced endpoint to list every issue on board {boardId}.
Get board {boardId}'s next issue page using token {nextPageToken}.
GET
/rest/software/1.0/board/{boardId}/issue/approximate-count
Count issues on a board · Get approximate issue count for board
#
Ask an LLM
“About how many issues are on a board right now?”
“Can I get an estimated board issue count for a JQL filter?”
Tell an agent
Estimate the number of issues on board {boardId}.
Count issues on board {boardId} matching {jql}.
Ask an LLM
“Which projects are associated with a board?”
“Can I page through the projects a board pulls issues from?”
Tell an agent
List the projects associated with board {boardId}.
Show the first {maxResults} projects linked to board {boardId}.
GET
/rest/agile/1.0/board/{boardId}/project/full
List projects statically tied to a board · Get projects full
#
Ask an LLM
“Which projects does a board's filter reference directly, rather than through a subquery?”
“Can I get the full, unpaginated list of projects statically bound to a board?”
Tell an agent
Get the full list of projects statically referenced by board {boardId}'s filter.
Show every project board {boardId}'s filter explicitly includes.
GET
/rest/agile/1.0/board/{boardId}/properties
List a board's property keys · Get board property keys
#
Ask an LLM
“What custom property keys are stored on a board?”
“Can I see which app data keys have been saved against a board?”
Tell an agent
List the property keys stored on board {boardId}.
Show me all custom data keys on board {boardId}.
DELETE
/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
Remove a board property · Delete board property
#
Ask an LLM
“Can I delete a custom property I stored on a board?”
“Who is allowed to remove a board property?”
Tell an agent destructive · confirm first
Delete property {propertyKey} from board {boardId}.
Remove the {propertyKey} custom data from board {boardId}.
GET
/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
Read a board property value · Get board property
#
Ask an LLM
“What value is stored under a particular property key on a board?”
“Can I read custom data saved on a board by key?”
Tell an agent
Get property {propertyKey} from board {boardId}.
Read the value of board {boardId}'s {propertyKey} property.
PUT
/rest/agile/1.0/board/{boardId}/properties/{propertyKey}
Store a property on a board · Set board property
#
Ask an LLM
“Can I save my own custom data against a board?”
“What permission do I need to write a board property?”
Tell an agent
Set property {propertyKey} on board {boardId}.
Store custom data under key {propertyKey} for board {boardId}.
GET
/rest/agile/1.0/board/{boardId}/quickfilter
List a board's quick filters · Get all quick filters
#
Ask an LLM
“What quick filters are defined on a board?”
“Can I page through all the quick filters for one board?”
Tell an agent
List the quick filters on board {boardId}.
Show all quick filter buttons configured for board {boardId}.
GET
/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
Get one quick filter on a board · Get quick filter
#
Ask an LLM
“What JQL does a specific quick filter on a board apply?”
“Can I look up a single quick filter by its ID?”
Tell an agent
Get quick filter {quickFilterId} from board {boardId}.
Show the JQL behind quick filter {quickFilterId} on board {boardId}.
GET
/rest/agile/1.0/board/{boardId}/reports
List reports available for a board · Get reports for board
#
Ask an LLM
“Which agile reports can I view for a board?”
“Are burndown or velocity style reports available on a particular board?”
Tell an agent
List the reports available for board {boardId}.
Show me what reports board {boardId} offers.
Ask an LLM
“What sprints exist on a board?”
“Can I list only the active or future sprints for a board?”
Tell an agent
List all sprints on board {boardId}.
Show the {state} sprints on board {boardId}.
GET
/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue
List a board's issues in a sprint · Get board issues for sprint
#
Ask an LLM
“Which issues are in a given sprint on a board, in rank order?”
“Can I filter a sprint's board issues by JQL using offset paging?”
Tell an agent
List issues in sprint {sprintId} on board {boardId}.
Show sprint {sprintId} issues on board {boardId} matching {jql}.
GET
/rest/software/1.0/board/{boardId}/sprint/{sprintId}/issue
List a board's sprint issues, token paged · Get board issues for sprint (enhanced)
#
Ask an LLM
“Is there an enhanced sprint-issues endpoint that uses nextPageToken?”
“Can I get a sprint's board issues with reconciliation of just-edited issues?”
Tell an agent
Use the enhanced endpoint to list sprint {sprintId} issues on board {boardId}.
Fetch token page {nextPageToken} of sprint {sprintId} issues on board {boardId}.
Ask an LLM
“Which release versions show up on a board?”
“Can I list only the unreleased versions for a board?”
Tell an agent
List the versions on board {boardId}.
Show versions on board {boardId} with released set to {released}.
Documentation
📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/