How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Servicedesk API

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

Jira Servicedesk API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Desk. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 22 operations across 16 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

22 operations 16 paths 56 schemas 3 DELETE13 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Servicedesk API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 61 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 22

Across 16 paths, the API surfaces 22 operations — 3 DELETE, 13 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Servicedesk 22
GET
/rest/servicedeskapi/servicedesk
Get service desks
getServiceDesks 2 params → 200401500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}
Get service desk by id
getServiceDeskById 1 param → 200401403404500
POST
/rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile
Attach temporary file
attachTemporaryFile 1 param body → 201400401403404413500
DELETE
/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
Remove customers
removeCustomers 1 param body → 204400401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
Get customers
getCustomers 4 params → 200401403404500
POST
/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
Add customers
addCustomers 1 param body → 204400401403404500
POST
/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/invite
Invite customer
inviteCustomer 2 params body → 201400401403404409500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article
Get articles
getArticles 7 params → 200400401403500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue
Get queues
getQueues 4 params → 200401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}
Get queue
getQueue 3 params → 200401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue
Get issues in queue
getIssuesInQueue 4 params → 200401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
Get request types
getRequestTypes 8 params → 200401403404500
POST
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
Create request type
createRequestType 1 param body → 200400401403404500
POST
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/permissions/check
Check request type permissions
checkRequestTypePermissions 1 param body → 200400401500
DELETE
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
Delete request type
deleteRequestType 2 params → 204400401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
Get request type by id
getRequestTypeById 3 params → 200401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field
Get request type fields
getRequestTypeFields 3 params → 200401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property
Get properties keys
getPropertiesKeys 2 params → 200400401404500
DELETE
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
Delete property
deleteProperty 3 params → 204400401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
Get property
getProperty 3 params → 200400401404500
PUT
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
Set property
setProperty 3 params → 200201400401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup
Get request type groups
getRequestTypeGroups 3 params → 200401403404500

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are RequestTypeDTO (15 properties), IssueBean (15 properties), IssueTransition (11 properties), HistoryMetadata (11 properties). Each schema is shown below with its type and property counts.

JsonTypeBean
object
The schema of a field.
6 properties 1 required
RequestTypeGroupDTO
object
2 properties
I18nErrorMessage
object
2 properties
PagedDTORequestTypeGroupDTO
object
7 properties
RequestTypePermissionCheckResponse
object
2 properties
FieldMetadata
object
The metadata describing an issue field.
10 properties 5 required
RequestTypeFieldDTO
object
9 properties
PagedDTOUserDTO
object
7 properties
SelfLinkDTO
object
1 property
Operations
object
Details of the operations that can be performed on the issue.
1 property
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
RequestTypeIconLinkDTO
object
1 property
IssueTransition
object
Details of an issue transition.
11 properties
PagedDTOArticleDTO
object
7 properties
CustomerRequestCreateMetaDTO
object
3 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
RequestTypeIconDTO
object
2 properties
PropertyKeys
object
List of property keys.
1 property
PagedDTORequestTypeDTO
object
7 properties
UserLinkDTO
object
3 properties
RequestTypeFieldValueDTO
object
3 properties
UserDTO
object
8 properties
PagedDTOQueueDTO
object
7 properties
ChangeDetails
object
A change item.
7 properties
StatusCategory
object
A status category.
5 properties
QueueDTO
object
6 properties
RequestTypeDTO
object
15 properties
ServiceDeskCustomerDTO
object
2 properties
StatusDetails
object
A status.
7 properties
MultipartFile
object
8 properties
ArticleDTO
object
4 properties
RequestTypeCreateDTO
object
4 properties
PagedLinkDTO
object
5 properties
PropertyKey
object
Property key details.
2 properties
PagedDTOIssueBean
object
7 properties
IssueUpdateMetadata
object
A list of editable field details.
1 property
Changelog
object
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
5 properties
ErrorResponse
object
2 properties
ContentDTO
object
1 property
AvatarUrlsBean
object
4 properties
LinkGroup
object
Details a link group, which defines issue operations.
6 properties
ServiceDeskCustomerInviteDTO
object
2 properties
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
IncludedFields
object
3 properties
ServiceDeskDTO
object
6 properties
Resource
object
9 properties
HistoryMetadata
object
Details of issue history metadata.
11 properties
UpdatedProjectCategory
object
A project category.
4 properties
SourceDTO
object
1 property
UserDetails
object
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: This occurs…
10 properties
ProjectDetails
object
Details about a project.
8 properties
RequestTypePermissionCheckRequestDTO
object
3 properties
IssueBean
object
Details about an issue.
15 properties
PagedDTOServiceDeskDTO
object
7 properties
PageOfChangelogs
object
A page of changelogs.
4 properties
HistoryMetadataParticipant
object
Details of user or system associated with a issue history metadata item.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-servicedesk-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Servicedesk API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.