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

GitHub Comments API

The Comments API from GitHub — 18 operation(s) for comments.

GitHub Comments API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

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

This API exposes 23 operations across 15 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

23 operations 15 paths 18 schemas 3 DELETE14 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Comments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 23

Across 15 paths, the API surfaces 23 operations — 3 DELETE, 14 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Comments 23
GET
/gists/{gist_id}/comments
GitHub List Gist Comments
listGistComments 3 params → 200304403404
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
GitHub List Discussion Comments
listDiscussionComments 6 params → 200
POST
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
GitHub Create Discussion Comment
createDiscussionComment 3 params body → 201
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
GitHub Get Discussion Comment
getDiscussionComment 4 params → 200
PATCH
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
GitHub Update Discussion Comment
updateDiscussionComment 4 params body → 200
DELETE
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
GitHub Delete Discussion Comment
deleteDiscussionComment 4 params → 204
GET
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
GitHub List Reactions for Team Discussion Comment
listReactionsForTeamDiscussionComment 7 params → 200
POST
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
GitHub Create Reaction for Team Discussion Comment
createReactionForTeamDiscussionComment 4 params body → 200201
DELETE
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}
GitHub Delete Team Discussion Comment Reaction
deleteTeamDiscussionCommentReaction 5 params → 204
GET
/repos/{owner}/{repo}/issues/comments
GitHub List Issue Comments for Repository
listIssueCommentsForRepository 10 params → 200404422
GET
/repos/{owner}/{repo}/issues/{issue_number}/comments
GitHub List Issue Comments
listIssueComments 9 params → 200404410
GET
/repos/{owner}/{repo}/pulls/comments
GitHub List Review Comments in Repository
listReviewCommentsInRepository 10 params → 200
GET
/repos/{owner}/{repo}/pulls/{pull_number}/comments
GitHub List Review Comments on Pull Request
listReviewCommentsOnPullRequest 11 params → 200
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments
GitHub List Comments for Pull Request Review
listCommentsForPullRequestReview 9 params → 200404
GET
/repos/{owner}/{repo}/comments
GitHub List Commit Comments for Repository
listCommitCommentsForRepository 7 params → 200
GET
/repos/{owner}/{repo}/commits/{commit_sha}/comments
GitHub List Commit Comments
listCommitComments 8 params → 200
GET
/teams/{team_id}/discussions/{discussion_number}/commentsdeprecated
GitHub List Discussion Comments (legacy)
listDiscussionCommentsLegacy 5 params → 200
POST
/teams/{team_id}/discussions/{discussion_number}/commentsdeprecated
GitHub Create Discussion Comment (legacy)
createDiscussionCommentLegacy 2 params body → 201
GET
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated
GitHub Get Discussion Comment (legacy)
getDiscussionCommentLegacy 3 params → 200
PATCH
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated
GitHub Update Discussion Comment (legacy)
updateDiscussionCommentLegacy 3 params body → 200
DELETE
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}deprecated
GitHub Delete Discussion Comment (legacy)
deleteDiscussionCommentLegacy 3 params → 204
GET
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactionsdeprecated
GitHub List Reactions for Team Discussion Comment (legacy)
listReactionsForTeamDiscussionCommentLegacy 6 params → 200
POST
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactionsdeprecated
GitHub Create Reaction for Team Discussion Comment (legacy)
createReactionForTeamDiscussionCommentLegacy 3 params body → 201

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are pull-request-review-comment (29 properties), review-comment (28 properties), nullable-simple-user_4 (21 properties), nullable-simple-user_3 (21 properties). Each schema is shown below with its type and property counts.

gist-comment
object
A comment made to a gist.
8 properties 8 required
basic-error
object
Basic Error
4 properties
author-association
string
How the author is associated with the repository.
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
reaction-rollup
object
10 properties 10 required
team-discussion-comment
object
A reply to a discussion within a team.
13 properties 12 required
reaction
object
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
5 properties 5 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties 9 required
nullable-integration
object
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…
17 properties 11 required
validation-error
object
Validation Error
3 properties 2 required
nullable-simple-user_2
object
GitHub user.
21 properties 18 required
link
object
Hypermedia Link
1 property 1 required
simple-user
object
GitHub user.
21 properties 18 required
review-comment
object
Legacy Review Comment
28 properties 18 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties 16 required
nullable-simple-user_3
object
GitHub user.
21 properties 18 required
nullable-simple-user_4
object
GitHub user.
21 properties 18 required
commit-comment
object
Commit Comment
14 properties 13 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-comments-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Comments 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.