Jira

Jira Request API

The Request API from Jira — 18 operation(s) for request.

GitHub OpenAPI

Operations 29

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

GET /rest/servicedeskapi/request List my service desk customer requests · Get customer requests #
Ask an LLM
“Which customer requests have I raised or participate in across all service desks?”
“Can I filter my Jira Service Management requests to only open ones awaiting approval?”
Tell an agent
List my customer requests in service desk {serviceDeskId}.
Find my customer requests matching {searchTerm} with status {requestStatus}.
POST /rest/servicedeskapi/request Raise a customer request in a service desk · Create customer request #
Ask an LLM
“How do I raise a new customer request in a Jira Service Management desk?”
“Can I open a service desk request on behalf of another customer?”
Tell an agent
Create a request of type {requestTypeId} in service desk {serviceDeskId}.
Raise a request in service desk {serviceDeskId} on behalf of {raiseOnBehalfOf}.
POST /rest/servicedeskapi/request/validate Check a customer request payload without creating it · Validate customer request #
Ask an LLM
“Can I test whether a customer request payload is valid before actually submitting it?”
“Is there a dry run that runs the same validations as creating a request, forms included?”
Tell an agent
Validate a request of type {requestTypeId} for service desk {serviceDeskId} without saving it.
Dry-run my customer request payload with fields {requestFieldValues} and report any errors.
GET /rest/servicedeskapi/request/{issueIdOrKey} Get one customer request · Get customer request by id or key #
Ask an LLM
“How can I look up a single service desk request by its key?”
“What details come back for one customer request, and can I expand extra sections?”
Tell an agent
Show customer request {issueIdOrKey}.
Get request {issueIdOrKey} with {expand} expanded.
GET /rest/servicedeskapi/request/{issueIdOrKey}/approval List approvals on a customer request · Get approvals #
Ask an LLM
“Which approvals are attached to this service desk request?”
“Can I see every approval step a customer request has gone through?”
Tell an agent
List all approvals on request {issueIdOrKey}.
Show the approvals for {issueIdOrKey}, {limit} at a time.
GET /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId} Check the status and approvers of one approval · Get approval by id #
Ask an LLM
“Who are the approvers on a specific approval, and has it been decided yet?”
“How do I check the current status of a single approval on a request?”
Tell an agent
Show approval {approvalId} on request {issueIdOrKey}.
Tell me who still needs to sign off approval {approvalId} for {issueIdOrKey}.
POST /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId} Approve or decline an approval · Answer approval #
Ask an LLM
“How do I approve or decline a pending approval assigned to me on a request?”
“Can I reject an approval request through the API?”
Tell an agent
Approve approval {approvalId} on request {issueIdOrKey}.
Answer approval {approvalId} on {issueIdOrKey} with decision {decision}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment List attachments on a customer request · Get attachments for request #
Ask an LLM
“Which files have been attached to a customer request?”
“Do customers only see public attachments when listing a request's files?”
Tell an agent
List attachments on request {issueIdOrKey} starting at {start}, {limit} per page.
Show the files attached to {issueIdOrKey}, page from {start} with size {limit}.
POST /rest/servicedeskapi/request/{issueIdOrKey}/attachment Comment on a request with uploaded files · Create comment with attachment #
Ask an LLM
“How do I post a comment that includes files I already uploaded as temporary attachments?”
“Can I attach files to a request as a public comment?”
Tell an agent
Attach temporary files {temporaryAttachmentIds} to request {issueIdOrKey} as a comment.
Add the uploaded files to {issueIdOrKey} with the note {additionalComment}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId} Download an attachment's contents · Get attachment content #
Ask an LLM
“How do I download the full file of an attachment on a service desk request?”
“Can I fetch the raw contents of a request attachment?”
Tell an agent
Download attachment {attachmentId} from request {issueIdOrKey}.
Get the file contents of attachment {attachmentId} on {issueIdOrKey}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail Get a thumbnail of a request attachment · Get attachment thumbnail #
Ask an LLM
“Can I get a small preview image of an attachment instead of the whole file?”
“Where do I fetch the thumbnail for a request attachment?”
Tell an agent
Get the thumbnail for attachment {attachmentId} on request {issueIdOrKey}.
Show a preview image of attachment {attachmentId} in {issueIdOrKey}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment List comments on a customer request · Get request comments #
Ask an LLM
“What comments have been left on a customer request?”
“Can I list only the internal comments on a request, or only public ones?”
Tell an agent
List the comments on request {issueIdOrKey}.
Show only internal comments on {issueIdOrKey}.
POST /rest/servicedeskapi/request/{issueIdOrKey}/comment Add a comment to a customer request · Create request comment #
Ask an LLM
“How do I reply to a customer on their service desk request?”
“Can I add an internal note to a request that the customer can't see?”
Tell an agent
Comment {body} on request {issueIdOrKey}.
Add an internal comment {body} to {issueIdOrKey} with public set to {public}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId} Get one comment on a customer request · Get request comment by id #
Ask an LLM
“How do I retrieve a specific comment on a request by its ID?”
“Can customers read an internal comment if they fetch it by ID?”
Tell an agent
Show comment {commentId} on request {issueIdOrKey}.
Get comment {commentId} from {issueIdOrKey} with {expand} expanded.
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment List files attached to a request comment · Get comment attachments #
Ask an LLM
“Which attachments are referenced in a particular comment?”
“Can I see the files someone added along with their comment?”
Tell an agent
List the attachments in comment {commentId} on request {issueIdOrKey}.
Show files linked to comment {commentId} of {issueIdOrKey}.
DELETE /rest/servicedeskapi/request/{issueIdOrKey}/notification Stop notifications from a request · Unsubscribe #
Ask an LLM
“How do I stop getting notifications from a customer request?”
“Can I mute a single service desk request without leaving it?”
Tell an agent destructive · confirm first
Unsubscribe me from notifications on request {issueIdOrKey}.
Mute updates for {issueIdOrKey}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/notification Check if I'm subscribed to a request's notifications · Get subscription status #
Ask an LLM
“Am I currently receiving notifications for this customer request?”
“How can I tell whether I'm subscribed to updates on a request?”
Tell an agent
Check whether I'm subscribed to notifications on {issueIdOrKey}.
Tell me my notification subscription status for request {issueIdOrKey}.
PUT /rest/servicedeskapi/request/{issueIdOrKey}/notification Subscribe to a request's notifications · Subscribe #
Ask an LLM
“How do I start getting notified about updates on a customer request?”
“Can I opt myself back in to notifications for a request?”
Tell an agent
Subscribe me to notifications on request {issueIdOrKey}.
Turn on update emails for {issueIdOrKey}.
DELETE /rest/servicedeskapi/request/{issueIdOrKey}/participant Remove participants from a customer request · Remove request participants #
Ask an LLM
“How do I take someone off a customer request's participant list?”
“Can I remove several participants from a request at once?”
Tell an agent destructive · confirm first
Remove {accountIds} from the participants on request {issueIdOrKey}.
Drop users {usernames} from {issueIdOrKey}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/participant List participants on a customer request · Get request participants #
Ask an LLM
“Who is participating in this customer request?”
“Which people besides the reporter are on a service desk request?”
Tell an agent
List the participants on request {issueIdOrKey}.
Show who has been added to {issueIdOrKey} as a participant.
POST /rest/servicedeskapi/request/{issueIdOrKey}/participant Add participants to a customer request · Add request participants #
Ask an LLM
“How do I add colleagues as participants on an existing request?”
“Can I share a customer request with other people after it's created?”
Tell an agent
Add {accountIds} as participants on request {issueIdOrKey}.
Share {issueIdOrKey} with users {usernames}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/sla List SLA records on a customer request · Get sla information #
Ask an LLM
“What SLAs are running on this service desk request and have any been breached?”
“Can I see completed and ongoing SLA cycles for a request?”
Tell an agent
List all SLA records for request {issueIdOrKey}.
Show SLA cycles on {issueIdOrKey}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId} Get one SLA metric on a customer request · Get sla information by id #
Ask an LLM
“How do I check a single SLA metric, like time to resolution, on a request?”
“Who is allowed to read the details of one SLA on a request?”
Tell an agent
Show SLA metric {slaMetricId} on request {issueIdOrKey}.
Get the details of SLA {slaMetricId} for {issueIdOrKey}.
GET /rest/servicedeskapi/request/{issueIdOrKey}/status Get a request's status history · Get customer request status #
Ask an LLM
“What statuses has a customer request moved through over time?”
“Can I see the status history of a request, most recent first?”
Tell an agent
Show the status history of request {issueIdOrKey}.
List every status {issueIdOrKey} has been in.
GET /rest/servicedeskapi/request/{issueIdOrKey}/transition List transitions I can perform on a request · Get customer transitions #
Ask an LLM
“Which workflow actions can I take on a customer request right now?”
“What transitions are available to a customer on their request?”
Tell an agent
List the transitions available on request {issueIdOrKey}.
Show what status changes I'm allowed to make on {issueIdOrKey}.
POST /rest/servicedeskapi/request/{issueIdOrKey}/transition Move a customer request to another status · Perform customer transition #
Ask an LLM
“How do I move a customer request through its workflow, like resolving it?”
“Can I add a reason comment when transitioning a request?”
Tell an agent
Perform transition {id} on request {issueIdOrKey}.
Transition {issueIdOrKey} using {id} with the comment {additionalComment}.
DELETE /rest/servicedeskapi/request/{requestIdOrKey}/feedback Delete the feedback on a request · Delete feedback #
Ask an LLM
“Can I remove a satisfaction rating I already left on a request?”
“Who is allowed to delete feedback on a customer request?”
Tell an agent destructive · confirm first
Delete the feedback on request {requestIdOrKey}.
Remove my rating from {requestIdOrKey}.
GET /rest/servicedeskapi/request/{requestIdOrKey}/feedback Get the customer feedback on a request · Get feedback #
Ask an LLM
“What satisfaction rating did the customer give on their request?”
“How can I read the feedback left on a resolved request?”
Tell an agent
Show the feedback on request {requestIdOrKey}.
Get the satisfaction rating for {requestIdOrKey}.
POST /rest/servicedeskapi/request/{requestIdOrKey}/feedback Leave feedback on a request · Post feedback #
Ask an LLM
“How does a reporter leave a satisfaction rating on their request?”
“Can I submit a rating with a written comment on a request?”
Tell an agent
Rate request {requestIdOrKey} {rating}.
Leave feedback on {requestIdOrKey} with rating {rating} and comment {comment}.

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/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-request-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-request-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jira-request-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Public REST API for Jira Service Management
  termsOfService: https://www.atlassian.com/legal/customer-agreement
  title: Service Management Public REST Request API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (212 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-request-api-openapi.yml