ATatlassian
Request

Get request comments

This method returns all comments on a customer request. No permissions error is provided if, for example, the user doesn't have access to the service desk or request, the method simply returns an empty response.

Permissions required: Permission to view the customer request.

Response limitations: Customers are returned public comments only.

get/rest/servicedeskapi/request/{issueIdOrKey}/comment

Request

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

Path parameters

issueIdOrKeystring required

The ID or key of the customer request whose comments will be retrieved.

Query parameters

publicboolean

Specifies whether to return public comments or not. Default: true.

internalboolean

Specifies whether to return internal comments or not. Default: true.

expandstring[]

A multi-value parameter indicating which properties of the comment to expand:

  • attachment returns the attachment details, if any, for each comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.)
  • renderedBody (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.
startinteger

The starting index of the returned comments. Base index: 0. See the Pagination section for more details.

limitinteger

The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.

Response

Returns the comments, on the specified page of the results.

_expandsstring[]
isLastPageboolean

Indicates if this is the last page of records (true) or not (false).

limitinteger

Number of items to be returned per page, up to the maximum set for these objects in the current implementation.

sizeinteger

Number of items returned in the page.

startinteger

Index of the first item returned in the page.

Changes

No operation changes recorded.