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 Request API

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

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

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

This API exposes 29 operations across 18 paths, and defines 59 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.

29 operations 18 paths 59 schemas 3 DELETE17 GET8 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 Request 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 29

Across 18 paths, the API surfaces 29 operations — 3 DELETE, 17 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

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

Schemas 59

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

JsonTypeBean
object
The schema of a field.
6 properties 1 required
ApprovalDTO
object
8 properties
CustomerTransitionExecutionDTO
object
2 properties
I18nErrorMessage
object
2 properties
FormValidationErrorDTO
object
5 properties
RequestValidationResultDTO
object
6 properties
DateDTO
object
4 properties
DurationDTO
object
2 properties
PagedDTOCustomerRequestDTO
object
7 properties
RequestTypeFieldDTO
object
9 properties
PagedDTOUserDTO
object
7 properties
SelfLinkDTO
object
1 property
PagedDTOCommentDTO
object
7 properties
RequestTypeIconLinkDTO
object
1 property
PagedDTOCustomerRequestStatusDTO
object
7 properties
CustomerRequestCreateMetaDTO
object
3 properties
RequestTypeIconDTO
object
2 properties
Form
object
1 property
SlaInformationOngoingCycleDTO
object
8 properties
CustomerTransitionDTO
object
2 properties
RequestTypeFieldValueDTO
object
3 properties
UserDTO
object
8 properties
RequestNotificationSubscriptionDTO
object
1 property
RequestCreateDTO
object
8 properties
SlaInformationDTO
object
6 properties
RequestTypeDTO
object
15 properties
AttachmentCreateResultDTO
object
2 properties
AdditionalCommentDTO
object
1 property
FormValidationErrorContextDTO
object
2 properties
PagedLinkDTO
object
5 properties
I18nErrorMessageDTO
object
2 properties
ApprovalDecisionRequestDTO
object
1 property
RenderedValueDTO
object
1 property
CustomerRequestLinkDTO
object
4 properties
CustomerRequestActionDTO
object
1 property
AttachmentLinkDTO
object
4 properties
CSATFeedbackFullDTO
object
3 properties
ApproverDTO
object
2 properties
ErrorResponse
object
2 properties
AttachmentDTO
object
6 properties
CommentCreateDTO
object
2 properties
CustomerRequestStatusDTO
object
3 properties
FormValidationErrorResponseDTO
object
3 properties
PagedDTOCustomerTransitionDTO
object
7 properties
PagedDTOApprovalDTO
object
7 properties
ServiceDeskDTO
object
6 properties
PagedDTOSlaInformationDTO
object
7 properties
CustomerRequestDTO
object
19 properties
CustomerRequestFieldValueDTO
object
4 properties
FormAnswer
object
7 properties
AttachmentCreateDTO
object
3 properties
RequestFieldValidationErrorDTO
object
2 properties
PagedDTOAttachmentDTO
object
7 properties
RequestParticipantUpdateDTO
object
2 properties
SlaInformationCompletedCycleDTO
object
7 properties
JsonNode
object
36 properties
CommentDTO
object
9 properties
CustomerRequestActionsDTO
object
4 properties
UserLinkDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-request-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 Request 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.