Octokit Rest API

Create reaction for a commit comment

Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.

octokit.reactions.createForCommitComment({
  owner,
  repo,
  comment_id,
  content,
});

Parameters

See also: GitHub Developer Guide documentation.

Create reaction for an issue

Create a reaction to an issue. A response with a Status: 200 OK means that you already added the reaction type to this issue.

octokit.reactions.createForIssue({
  owner,
  repo,
  issue_number,
  content,
});

Parameters

See also: GitHub Developer Guide documentation.

Create reaction for an issue comment

Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.

octokit.reactions.createForIssueComment({
  owner,
  repo,
  comment_id,
  content,
});

Parameters

See also: GitHub Developer Guide documentation.

Create reaction for a pull request review comment

Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.

octokit.reactions.createForPullRequestReviewComment({
  owner,
  repo,
  comment_id,
  content,
});

Parameters

See also: GitHub Developer Guide documentation.

Create reaction for a team discussion comment

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

octokit.reactions.createForTeamDiscussionCommentInOrg({
  org,
  team_slug,
  discussion_number,
  comment_number,
  content,
});

Parameters

See also: GitHub Developer Guide documentation.

Create reaction for a team discussion

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

octokit.reactions.createForTeamDiscussionInOrg({
  org,
  team_slug,
  discussion_number,
  content,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a commit comment reaction

Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to a commit comment.

octokit.reactions.deleteForCommitComment({
  owner,
  repo,
  comment_id,
  reaction_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete an issue reaction

Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

Delete a reaction to an issue.

octokit.reactions.deleteForIssue({
  owner,
  repo,
  issue_number,
  reaction_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete an issue comment reaction

Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to an issue comment.

octokit.reactions.deleteForIssueComment({
  owner,
  repo,
  comment_id,
  reaction_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a pull request comment reaction

Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to a pull request review comment.

octokit.reactions.deleteForPullRequestComment({
  owner,
  repo,
  comment_id,
  reaction_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete team discussion reaction

Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.

octokit.reactions.deleteForTeamDiscussion({
  org,
  team_slug,
  discussion_number,
  reaction_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete team discussion comment reaction

Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.

Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.

octokit.reactions.deleteForTeamDiscussionComment({
  org,
  team_slug,
  discussion_number,
  comment_number,
  reaction_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a reaction (Legacy)

This method is deprecated.

Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.

OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

octokit.reactions.deleteLegacy({
  reaction_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List reactions for a commit comment

List the reactions to a commit comment.

octokit.reactions.listForCommitComment({
  owner,
  repo,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List reactions for an issue

List the reactions to an issue.

octokit.reactions.listForIssue({
  owner,
  repo,
  issue_number,
});

Parameters

See also: GitHub Developer Guide documentation.

List reactions for an issue comment

List the reactions to an issue comment.

octokit.reactions.listForIssueComment({
  owner,
  repo,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List reactions for a pull request review comment

List the reactions to a pull request review comment.

octokit.reactions.listForPullRequestReviewComment({
  owner,
  repo,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List reactions for a team discussion comment

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

octokit.reactions.listForTeamDiscussionCommentInOrg({
  org,
  team_slug,
  discussion_number,
  comment_number,
});

Parameters

See also: GitHub Developer Guide documentation.

List reactions for a team discussion

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

octokit.reactions.listForTeamDiscussionInOrg({
  org,
  team_slug,
  discussion_number,
});

Parameters

See also: GitHub Developer Guide documentation.