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 Service Management REST API

The first-party Jira Service Management REST API at /rest/servicedeskapi — 75 operations covering service desks, customer requests, request types, queues, SLAs, organizations, customers and the knowledge base. Harvested verbatim from Atlassian.

Jira Service Management REST API is one of 12 APIs that Atlassian Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 75 operations across 50 paths, organized into 9 resource areas, and defines 117 schemas. It is described by OpenAPI 3.0.1, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

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

75 operations 50 paths 117 schemas 10 DELETE42 GET19 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Jira Service Management REST 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 75

Across 50 paths, the API surfaces 75 operations — 10 DELETE, 42 GET, 19 POST, 4 PUT. They span 9 resource areas: Assets, Customer, Operations, Info, Knowledgebase, Organization, Request, Requesttype, Servicedesk. Each is listed below with its method, path, parameters, and response codes.

Assets 2
GET
/rest/servicedeskapi/assets/workspace
Get assets workspaces
getAssetsWorkspaces 2 params → 200401403500
GET
/rest/servicedeskapi/insight/workspace
Get insight workspaces
getInsightWorkspaces 2 params → 200500
Customer 2
POST
/rest/servicedeskapi/customer
Create customer
createCustomer 1 param body → 201400401403409500
PUT
/rest/servicedeskapi/customer/user/{accountId}/revoke-portal-only-access
Revoke portal only access for user
revokePortalOnlyAccessForUser 1 param → 204401403404500
Operations 3
POST
/rest/servicedeskapi/customer/skip-permission-check
Create customer
createCustomer 1 param body → 201
GET
/rest/servicedeskapi/knowledgebase/article/view/{pageId}
View knowledge base article
viewArticle 1 param → 200
POST
/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/skip-permission-check
Add customers
addCustomers 1 param body → 204
Info 1
GET
/rest/servicedeskapi/info
Get info
getInfo → 200500
Knowledgebase 1
GET
/rest/servicedeskapi/knowledgebase/article
Get articles
getArticles 6 params → 200400401403500
Organization 14
GET
/rest/servicedeskapi/organization
Get organizations
getOrganizations 3 params → 200401403404500
POST
/rest/servicedeskapi/organization
Create organization
createOrganization body → 201400401403500
DELETE
/rest/servicedeskapi/organization/{organizationId}
Delete organization
deleteOrganization 1 param → 204401403404500
GET
/rest/servicedeskapi/organization/{organizationId}
Get organization
getOrganization 1 param → 200401403404500
GET
/rest/servicedeskapi/organization/{organizationId}/property
Get properties keys
getPropertiesKeys 1 param → 200400401403404500
DELETE
/rest/servicedeskapi/organization/{organizationId}/property/{propertyKey}
Delete property
deleteProperty 2 params → 204400401403404500
GET
/rest/servicedeskapi/organization/{organizationId}/property/{propertyKey}
Get property
getProperty 2 params → 200400401403404500
PUT
/rest/servicedeskapi/organization/{organizationId}/property/{propertyKey}
Set property
setProperty 2 params body → 200201400401403404500
DELETE
/rest/servicedeskapi/organization/{organizationId}/user
Remove users from organization
removeUsersFromOrganization 1 param body → 204400401403404500
GET
/rest/servicedeskapi/organization/{organizationId}/user
Get users in organization
getUsersInOrganization 3 params → 200401403404500
POST
/rest/servicedeskapi/organization/{organizationId}/user
Add users to organization
addUsersToOrganization 1 param body → 204400401403404500
DELETE
/rest/servicedeskapi/servicedesk/{serviceDeskId}/organization
Remove organization
removeOrganization 1 param body → 204401403404500
GET
/rest/servicedeskapi/servicedesk/{serviceDeskId}/organization
Get organizations
getOrganizations 4 params → 200401403404500
POST
/rest/servicedeskapi/servicedesk/{serviceDeskId}/organization
Add organization
addOrganization 1 param body → 204401403404500
Request 29
GET
/rest/servicedeskapi/request
Get customer requests
getCustomerRequests 10 params → 200401404500
POST
/rest/servicedeskapi/request
Create customer request
createCustomerRequest body → 201400401403422500
POST
/rest/servicedeskapi/request/validate
Validate customer request
validateCustomerRequest body → 200400401403500
GET
/rest/servicedeskapi/request/{issueIdOrKey}
Get customer request by id or key
getCustomerRequestByIdOrKey 2 params → 200401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/approval
Get approvals
getApprovals 3 params → 200401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
Get approval by id
getApprovalById 2 params → 200401403404500
POST
/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
Answer approval
answerApproval 2 params body → 200400401403404409500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/attachment
Get attachments for request
getAttachmentsForRequest 3 params → 200401403404500
POST
/rest/servicedeskapi/request/{issueIdOrKey}/attachment
Create comment with attachment
createCommentWithAttachment 1 param body → 201400401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}
Get attachment content
getAttachmentContent 2 params → 200303401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail
Get attachment thumbnail
getAttachmentThumbnail 2 params → 200303400401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/comment
Get request comments
getRequestComments 6 params → 200401404500
POST
/rest/servicedeskapi/request/{issueIdOrKey}/comment
Create request comment
createRequestComment 1 param body → 201400401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}
Get request comment by id
getRequestCommentById 3 params → 200401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment
Get comment attachments
getCommentAttachments 4 params → 200401403404500
DELETE
/rest/servicedeskapi/request/{issueIdOrKey}/notification
Unsubscribe
unsubscribe 1 param → 204401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/notification
Get subscription status
getSubscriptionStatus 1 param → 200401403404500
PUT
/rest/servicedeskapi/request/{issueIdOrKey}/notification
Subscribe
subscribe 1 param → 204401403404500
DELETE
/rest/servicedeskapi/request/{issueIdOrKey}/participant
Remove request participants
removeRequestParticipants 1 param body → 200400401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/participant
Get request participants
getRequestParticipants 3 params → 200401403404500
POST
/rest/servicedeskapi/request/{issueIdOrKey}/participant
Add request participants
addRequestParticipants 1 param body → 200400401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/sla
Get sla information
getSlaInformation 3 params → 200401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}
Get sla information by id
getSlaInformationById 2 params → 200401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/status
Get customer request status
getCustomerRequestStatus 3 params → 200401403404500
GET
/rest/servicedeskapi/request/{issueIdOrKey}/transition
Get customer transitions
getCustomerTransitions 3 params → 200401403404500
POST
/rest/servicedeskapi/request/{issueIdOrKey}/transition
Perform customer transition
performCustomerTransition 1 param body → 204400401403404500
DELETE
/rest/servicedeskapi/request/{requestIdOrKey}/feedback
Delete feedback
deleteFeedback 1 param → 204401403404500
GET
/rest/servicedeskapi/request/{requestIdOrKey}/feedback
Get feedback
getFeedback 1 param → 200400401403404500
POST
/rest/servicedeskapi/request/{requestIdOrKey}/feedback
Post feedback
postFeedback 1 param body → 201400401403404500
Requesttype 1
GET
/rest/servicedeskapi/requesttype
Get all request types
getAllRequestTypes 7 params → 200401500
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 117

The contract defines 117 schemas that model the data the API accepts and returns. The most detailed are JsonNode (36 properties), CustomerRequestDTO (19 properties), RequestTypeDTO (15 properties), IssueBean (15 properties). Each schema is shown below with its type and property counts.

AdditionalCommentDTO
object
1 property
ApprovalDTO
object
8 properties
ApprovalDecisionRequestDTO
object
1 property
ApproverDTO
object
2 properties
ArticleDTO
object
4 properties
AssetsWorkspaceDTO
object
Details of an Assets workspace ID.
1 property
AttachmentCreateDTO
object
3 properties
AttachmentCreateResultDTO
object
2 properties
AttachmentDTO
object
6 properties
AttachmentLinkDTO
object
4 properties
AvatarUrlsBean
object
4 properties
CSATFeedbackFullDTO
object
3 properties
ChangeDetails
object
A change item.
7 properties
Changelog
object
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
5 properties
CommentCreateDTO
object
2 properties
CommentDTO
object
9 properties
ContentDTO
object
1 property
CustomerCreateDTO
object
3 properties
CustomerRequestActionDTO
object
1 property
CustomerRequestActionsDTO
object
4 properties
CustomerRequestCreateMetaDTO
object
3 properties
CustomerRequestDTO
object
19 properties
CustomerRequestFieldValueDTO
object
4 properties
CustomerRequestLinkDTO
object
4 properties
CustomerRequestStatusDTO
object
3 properties
CustomerTransitionDTO
object
2 properties
CustomerTransitionExecutionDTO
object
2 properties
DateDTO
object
4 properties
DurationDTO
object
2 properties
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
ErrorResponse
object
2 properties
Expandable
object
1 property
FieldMetadata
object
The metadata describing an issue field.
10 properties 5 required
Form
object
1 property
FormAnswer
object
7 properties
FormValidationErrorContextDTO
object
2 properties
FormValidationErrorDTO
object
5 properties
FormValidationErrorResponseDTO
object
3 properties
HistoryMetadata
object
Details of issue history metadata.
11 properties
HistoryMetadataParticipant
object
Details of user or system associated with a issue history metadata item.
6 properties
I18nErrorMessage
object
2 properties
I18nErrorMessageDTO
object
2 properties
IncludedFields
object
3 properties
InputStreamSource
object
1 property
InsightWorkspaceDTO
object
Details of an insight workspace ID.
1 property
IssueBean
object
Details about an issue.
15 properties
IssueTransition
object
Details of an issue transition.
11 properties
IssueUpdateMetadata
object
A list of editable field details.
1 property
JsonNode
object
36 properties
JsonTypeBean
object
The schema of a field.
6 properties 1 required
LinkGroup
object
Details a link group, which defines issue operations.
6 properties
Linkable
object
1 property
LinkableAttachmentLinkDTO
object
1 property
LinkableCustomerRequestLinkDTO
object
1 property
LinkableUserLinkDTO
object
1 property
MultipartFile
object
8 properties
Operations
object
Details of the operations that can be performed on the issue.
1 property
OrganizationCreateDTO
object
1 property 1 required
OrganizationDTO
object
6 properties
OrganizationServiceDeskUpdateDTO
object
2 properties 1 required
PageOfChangelogs
object
A page of changelogs.
4 properties
PagedDTOApprovalDTO
object
7 properties
PagedDTOArticleDTO
object
7 properties
PagedDTOAssetsWorkspaceDTO
object
7 properties
PagedDTOAttachmentDTO
object
7 properties
PagedDTOCommentDTO
object
7 properties
PagedDTOCustomerRequestDTO
object
7 properties
PagedDTOCustomerRequestStatusDTO
object
7 properties
PagedDTOCustomerTransitionDTO
object
7 properties
PagedDTOInsightWorkspaceDTO
object
7 properties
PagedDTOIssueBean
object
7 properties
PagedDTOOrganizationDTO
object
7 properties
PagedDTOQueueDTO
object
7 properties
PagedDTORequestTypeDTO
object
7 properties
PagedDTORequestTypeGroupDTO
object
7 properties
PagedDTOServiceDeskDTO
object
7 properties
PagedDTOSlaInformationDTO
object
7 properties
PagedDTOUserDTO
object
7 properties
PagedLinkDTO
object
5 properties
ProjectDetails
object
Details about a project.
8 properties
PropertyKey
object
Property key details.
2 properties
PropertyKeys
object
List of property keys.
1 property
QueueDTO
object
6 properties
RenderedValueDTO
object
1 property
RequestCreateDTO
object
8 properties
RequestFieldValidationErrorDTO
object
2 properties
RequestNotificationSubscriptionDTO
object
1 property
RequestParticipantUpdateDTO
object
2 properties
RequestTypeCreateDTO
object
4 properties
RequestTypeDTO
object
15 properties
RequestTypeFieldDTO
object
9 properties
RequestTypeFieldValueDTO
object
3 properties
RequestTypeGroupDTO
object
2 properties
RequestTypeIconDTO
object
2 properties
RequestTypeIconLinkDTO
object
1 property
RequestTypePermissionCheckRequestDTO
object
3 properties
RequestTypePermissionCheckResponse
object
2 properties
RequestValidationResultDTO
object
6 properties
Resource
object
9 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
SelfLinkDTO
object
1 property
ServiceDeskCustomerDTO
object
2 properties
ServiceDeskCustomerInviteDTO
object
2 properties
ServiceDeskDTO
object
6 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
SlaInformationCompletedCycleDTO
object
7 properties
SlaInformationDTO
object
6 properties
SlaInformationOngoingCycleDTO
object
8 properties
SoftwareInfoDTO
object
6 properties
SourceDTO
object
1 property
StatusCategory
object
A status category.
5 properties
StatusDetails
object
A status.
7 properties
UpdatedProjectCategory
object
A project category.
4 properties
UserDTO
object
8 properties
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
UserLinkDTO
object
3 properties
UsersOrganizationUpdateDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-jira-service-management-openapi.json Raw ↑

Other APIs Atlassian Jira publishes across the network.

Atlassian Jira Fields API
Atlassian Jira Issue Comments API
Atlassian Jira Issue Search API
Atlassian Jira Issue Transitions API
Atlassian Jira Issue Worklogs API
Atlassian Jira Issues API
Atlassian Jira Projects API
Atlassian Jira Users API
Atlassian Jira Cloud Platform REST API v3
Jira Software Cloud API
Atlassian Remote MCP Server
Where this information came from

This is an independent, third-party profile of Jira Service Management REST 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.