Sample - GitHub REST API
GET/repos/{owner}/{repo}/issues/{issue_number}/comments

List issue comments

Lists comments on an issue or pull request in ascending comment ID order. Use since to return comments updated after a specified ISO 8601 timestamp, and use page and per_page to paginate the results. Select a media type when you need raw, text, or HTML representations of comment Markdown.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 parameters
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
issue_numberintegerrequired
The integer that identifies the issue or pull request within the repository.
sincestringoptional
Return comments updated after this timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
per_pageintegeroptional
The number of comments to return per page, up to 100. Defaults to 30 when omitted.
Default:30
pageintegeroptional
The page number to retrieve. Defaults to 1 when omitted.
Default:1

3 status codes
200Returns an array of issue comment objects ordered by ascending ID, including comment content, author, timestamps, URLs, and reactions.
idintegerrequired
Unique identifier of the issue comment
node_idstringrequired
urlstringrequired
URL for the issue comment
bodystringoptional
Contents of the issue comment
body_textstringoptional
body_htmlstringoptional
html_urlstringrequired
userobjectrequired
A GitHub user.
created_atstringrequired
updated_atstringrequired
issue_urlstringrequired
author_associationstringoptional
How the author is associated with the repository.
Allowed:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
performed_via_github_appobjectoptional
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
reactionsobjectoptional
pinobjectoptional
Context around who pinned an issue comment and when it was pinned.
minimizedobjectoptional
Details about why an issue comment was minimized.
404Returned when the repository or issue does not exist or is not accessible.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
410Returned when the issue is gone.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned when the repository or issue cannot be found, and a 410 is returned when the issue is gone. since must be an ISO 8601 datetime when supplied, while per_page must not exceed 100. Use page and per_page to paginate the results.