Jira

Jira Servicedesk API

The Servicedesk API from Jira — 16 operation(s) for servicedesk.

GitHub OpenAPI
Business capability
IT Service Management BC-600.30

Operations 22

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/servicedesk List all accessible service desks · Get service desks #
Ask an LLM
“Which service desks can I access in our Jira Service Management instance?”
“Can I page through every service desk when there are hundreds of them?”
Tell an agent
List all the service desks I have access to.
Show the next {limit} service desks starting at index {start}.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId} Get details of one service desk · Get service desk by id #
Ask an LLM
“What are the details of a specific service desk if I only have its ID?”
“Can I look up a service desk using its project key instead of its ID?”
Tell an agent
Get the details of service desk {serviceDeskId}.
Show me the name and project behind service desk {serviceDeskId}.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile Upload a temporary attachment to a service desk · Attach temporary file #
Ask an LLM
“How do I upload a file to a service desk before attaching it to a customer request?”
“Can I stage several temporary attachments on a service desk at once?”
Tell an agent
Upload this file as a temporary attachment on service desk {serviceDeskId}.
Stage these screenshots on service desk {serviceDeskId} so I can attach them to a request later.
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer Remove customers from a service desk · Remove customers #
Ask an LLM
“How do I take customers off a closed-access service desk?”
“Does removing customers from a service desk require it to have closed access?”
Tell an agent destructive · confirm first
Remove account IDs {accountIds} from the customers of service desk {serviceDeskId}.
Revoke customer access to service desk {serviceDeskId} for these users.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer List customers on a service desk · Get customers #
Ask an LLM
“Who are the customers registered on a given service desk?”
“Can I find a service desk customer by part of their name or email?”
Tell an agent
List the customers of service desk {serviceDeskId}.
Find customers on service desk {serviceDeskId} matching {query}.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer Add existing users as service desk customers · Add customers #
Ask an LLM
“How do I give existing users customer access to a service desk?”
“What happens if I add a customer who is already on the service desk?”
Tell an agent
Add account IDs {accountIds} as customers of service desk {serviceDeskId}.
Grant customer access on service desk {serviceDeskId} to these existing users.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/invite Invite a new customer by email · Invite customer #
Ask an LLM
“How do I email an invitation to someone so they can use our help center?”
“Will inviting a customer create an account if they don't have one yet?”
Tell an agent
Invite {email} to service desk {serviceDeskId} as a customer.
Send a customer invitation to {email} named {displayName} for service desk {serviceDeskId}.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article Search a service desk's knowledge base articles · Get articles #
Ask an LLM
“Which knowledge base articles linked to a service desk mention a given topic?”
“Can I get matching terms highlighted in knowledge base search results?”
Tell an agent
Search the knowledge base of service desk {serviceDeskId} for {query}.
Find help articles about {query} for service desk {serviceDeskId} with highlighting turned on.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue List the queues in a service desk · Get queues #
Ask an LLM
“What queues are set up in a service desk?”
“Can I see how many requests are sitting in each queue?”
Tell an agent
List the queues in service desk {serviceDeskId}.
Show every queue in service desk {serviceDeskId} with its request count.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId} Get one service desk queue · Get queue #
Ask an LLM
“What are the settings of a single queue in my service desk?”
“Can I check the request count for just one queue?”
Tell an agent
Get queue {queueId} in service desk {serviceDeskId}.
Get queue {queueId} of service desk {serviceDeskId} including its request count.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue List customer requests in a queue · Get issues in queue #
Ask an LLM
“Which customer requests are currently waiting in a particular queue?”
“Why do requests from a queue only show some fields?”
Tell an agent
List the requests in queue {queueId} of service desk {serviceDeskId}.
Show the first {limit} tickets sitting in queue {queueId} on service desk {serviceDeskId}.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype List request types on a service desk · Get request types #
Ask an LLM
“What kinds of requests can customers raise on a service desk?”
“Can I filter request types by group or by a word in their name?”
Tell an agent
List the request types on service desk {serviceDeskId}.
Find request types on service desk {serviceDeskId} matching {searchQuery}.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype Create a request type from an issue type · Create request type #
Ask an LLM
“How do I add a new request type to a service desk based on an issue type?”
“Why doesn't a newly created request type show up on the customer portal?”
Tell an agent
Create a request type called {name} on service desk {serviceDeskId} using issue type {issueTypeId}.
Add request type {name} to service desk {serviceDeskId} with help text {helpText}.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/permissions/check Check a user's permissions on request types · Check request type permissions #
Ask an LLM
“Which request types can a given user submit or administer?”
“How many request types can I check permissions for in one call?”
Tell an agent
Check which of request types {requestTypeIds} user {accountId} can submit on service desk {serviceDeskId}.
Tell me which request types on service desk {serviceDeskId} I'm allowed to administer.
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId} Delete a request type · Delete request type #
Ask an LLM
“How do I delete a request type from a service desk?”
“Does deleting a request type strip it from existing customer requests?”
Tell an agent destructive · confirm first
Delete request type {requestTypeId} from service desk {serviceDeskId}.
Remove the retired request type {requestTypeId} from service desk {serviceDeskId} entirely.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId} Get one request type · Get request type by id #
Ask an LLM
“What are the details of a single customer request type?”
“Can a request type be read without signing in?”
Tell an agent
Get request type {requestTypeId} from service desk {serviceDeskId}.
Show the name and description of request type {requestTypeId} on service desk {serviceDeskId}.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field List fields for a request type · Get request type fields #
Ask an LLM
“What fields does a customer fill in for a given request type?”
“Can I tell whether I'm allowed to raise a request on behalf of another customer?”
Tell an agent
List the fields of request type {requestTypeId} on service desk {serviceDeskId}.
Show which fields are required when raising request type {requestTypeId} in service desk {serviceDeskId}.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property List property keys on a request type · Get properties keys #
Ask an LLM
“What custom property keys are stored against a request type?”
“Which keys of custom data does a service desk request type hold?”
Tell an agent
List the property keys on request type {requestTypeId} in service desk {serviceDeskId}.
Show all custom property keys saved for request type {requestTypeId} of service desk {serviceDeskId}.
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey} Delete a request type property · Delete property #
Ask an LLM
“How do I remove a custom property from a request type?”
“Can I clear custom data an app stored on a service desk request type?”
Tell an agent destructive · confirm first
Delete property {propertyKey} from request type {requestTypeId} in service desk {serviceDeskId}.
Remove the {propertyKey} entry saved on request type {requestTypeId} of service desk {serviceDeskId}.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey} Read a request type property value · Get property #
Ask an LLM
“What value is stored in a specific property of a request type?”
“Can I read custom data my app saved on a service desk request type?”
Tell an agent
Get property {propertyKey} of request type {requestTypeId} in service desk {serviceDeskId}.
Read the {propertyKey} value saved on request type {requestTypeId} for service desk {serviceDeskId}.
PUT /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey} Set a request type property value · Set property #
Ask an LLM
“How do I store custom data against a service desk request type?”
“How long can a request type property key be?”
Tell an agent
Set property {propertyKey} on request type {requestTypeId} in service desk {serviceDeskId} to this JSON.
Save this config as {propertyKey} on request type {requestTypeId} of service desk {serviceDeskId}.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup List request type groups on a service desk · Get request type groups #
Ask an LLM
“How are request types grouped on a service desk's customer portal?”
“In what order do request type groups appear on the portal?”
Tell an agent
List the request type groups for service desk {serviceDeskId}.
Show the portal categories that organize request types on service desk {serviceDeskId}.

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://artifacts.apis.io/jira/openapi/jira-servicedesk-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-servicedesk-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-servicedesk-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 Servicedesk API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (154 KB total) ---
# Full source: https://artifacts.apis.io/jira/openapi/jira-servicedesk-api-openapi.yml