v2
OpenAPI 3.0.12026-08-0174115357.9 KBGet 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.
Path parameters
The ID or key of the customer request whose comments will be retrieved.
Query parameters
Specifies whether to return public comments or not. Default: true.
Specifies whether to return internal comments or not. Default: true.
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.
The starting index of the returned comments. Base index: 0. See the Pagination section for more details.
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.