Request

Get customer request by id or key

This method returns a customer request.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.

Note: requestFieldValues does not include hidden fields. To get a list of request type fields that includes hidden fields, see /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field

get/rest/servicedeskapi/request/{issueIdOrKey}

Request

Base URL
https://your-domain.atlassian.net
URL
https://your-domain.atlassian.net/rest/servicedeskapi/request/{issueIdOrKey}
Auth
OAuth 2
Authorization code: https://auth.atlassian.com/authorize
Token URL: https://auth.atlassian.com/oauth/token scopes: read:servicedesk-request

issueIdOrKeystring required

The ID or Key of the customer request to be returned

expandstring[]

A multi-value parameter indicating which properties of the customer request to expand, where:

serviceDesk returns additional service desk details.
requestType returns additional customer request type details.
participant returns the participant details.
sla returns the SLA information.
status returns the status transitions, in chronological order.
attachment returns the attachments.
action returns the actions that the user can or cannot perform.
comment returns the comments.
comment.attachment returns the attachment details for each comment.
comment.renderedBody (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment.

Returns the customer request.

_expandsstring[]

List of items that can be expanded in the response by specifying the expand query parameter.

issueIdstring

ID of the request, as the peer issue ID.

issueKeystring

Key of the request, as the peer issue key.

requestTypeIdstring

ID of the request type for the request.

serviceDeskIdstring

ID of the service desk the request belongs to.

summarystring

Summary of the request created