reactions.md

octokit.reactions

Previous: rateLimit | Index | Next: repos

Table of Contents

Click to expand

• createForCommitComment(options)
• createForIssue(options)
• createForIssueComment(options)
• createForPullRequestReviewComment(options)
• createForTeamDiscussionCommentInOrg(options)
• createForTeamDiscussionInOrg(options)
• deleteForCommitComment(options)
• deleteForIssue(options)
• deleteForIssueComment(options)
• deleteForPullRequestComment(options)
• deleteForTeamDiscussion(options)
• deleteForTeamDiscussionComment(options)
• deleteLegacy(options)
• listForCommitComment(options)
• listForIssue(options)
• listForIssueComment(options)
• listForPullRequestReviewComment(options)
• listForTeamDiscussionCommentInOrg(options)
• listForTeamDiscussionInOrg(options)

createForCommitComment(options)

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.

Usage

const response = await octokit.reactions.createForCommitComment({
  owner,
  repo,
  comment_id,
  content
})

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• content (required, string): The reaction type to add to the commit comment.

Reaction exists (HTTP 200)

Example

const response = {
  status: 200,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

Reaction created (HTTP 201)

Example

const response = {
  status: 201,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.createForCommitComment({
    owner,
    repo,
    comment_id,
    content
  })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

createForIssue(options)

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

Usage

const response = await octokit.reactions.createForIssue({
  owner,
  repo,
  issue_number,
  content
})

Options

• owner (required, string)
• repo (required, string)
• issue_number (required, integer)
• content (required, string): The reaction type to add to the issue.

Response (HTTP 201)

Example

const response = {
  status: 201,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.createForIssue({
    owner,
    repo,
    issue_number,
    content
  })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

createForIssueComment(options)

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.

Usage

const response = await octokit.reactions.createForIssueComment({
  owner,
  repo,
  comment_id,
  content
})

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• content (required, string): The reaction type to add to the issue comment.

Reaction exists (HTTP 200)

Example

const response = {
  status: 200,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

Reaction created (HTTP 201)

Example

const response = {
  status: 201,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.createForIssueComment({
    owner,
    repo,
    comment_id,
    content
  })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

createForPullRequestReviewComment(options)

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.

Usage

const response = await octokit.reactions.createForPullRequestReviewComment({
  owner,
  repo,
  comment_id,
  content
})

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• content (required, string): The reaction type to add to the pull request review comment.

Reaction exists (HTTP 200)

Example

const response = {
  status: 200,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

Reaction created (HTTP 201)

Example

const response = {
  status: 201,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.createForPullRequestReviewComment({
    owner,
    repo,
    comment_id,
    content
  })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

createForTeamDiscussionCommentInOrg(options)

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.

Usage

const response = await octokit.reactions.createForTeamDiscussionCommentInOrg({
  org,
  team_slug,
  discussion_number,
  comment_number,
  content
})

Options

• org (required, string)
• team_slug (required, string)
• discussion_number (required, integer)
• comment_number (required, integer)
• content (required, string): The reaction type to add to the team discussion comment.

Response (HTTP 201)

Example

const response = {
  status: 201,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

createForTeamDiscussionInOrg(options)

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.

Usage

const response = await octokit.reactions.createForTeamDiscussionInOrg({
  org,
  team_slug,
  discussion_number,
  content
})

Options

• org (required, string)
• team_slug (required, string)
• discussion_number (required, integer)
• content (required, string): The reaction type to add to the team discussion.

Response (HTTP 201)

Example

const response = {
  status: 201,
  data: {
    id: 1,
    node_id: 'MDg6UmVhY3Rpb24x',
    user: {
      login: 'octocat',
      id: 1,
      node_id: 'MDQ6VXNlcjE=',
      avatar_url: 'https://github.com/images/error/octocat_happy.gif',
      gravatar_id: '',
      url: 'https://api.github.com/users/octocat',
      html_url: 'https://github.com/octocat',
      followers_url: 'https://api.github.com/users/octocat/followers',
      following_url:
        'https://api.github.com/users/octocat/following{/other_user}',
      gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
      starred_url:
        'https://api.github.com/users/octocat/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
      organizations_url: 'https://api.github.com/users/octocat/orgs',
      repos_url: 'https://api.github.com/users/octocat/repos',
      events_url: 'https://api.github.com/users/octocat/events{/privacy}',
      received_events_url:
        'https://api.github.com/users/octocat/received_events',
      type: 'User',
      site_admin: false
    },
    content: 'heart',
    created_at: '2016-05-20T20:09:31Z'
  }
}

deleteForCommitComment(options)

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.

Usage

const response = await octokit.reactions.deleteForCommitComment({
  owner,
  repo,
  comment_id,
  reaction_id
})

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• reaction_id (required, integer)

Empty response (HTTP 204)

Example

const response = { status: 204 }

deleteForIssue(options)

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.

Usage

const response = await octokit.reactions.deleteForIssue({
  owner,
  repo,
  issue_number,
  reaction_id
})

Options

• owner (required, string)
• repo (required, string)
• issue_number (required, integer)
• reaction_id (required, integer)

Empty response (HTTP 204)

Example

const response = { status: 204 }

deleteForIssueComment(options)

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.

Usage

const response = await octokit.reactions.deleteForIssueComment({
  owner,
  repo,
  comment_id,
  reaction_id
})

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• reaction_id (required, integer)

Empty response (HTTP 204)

Example

const response = { status: 204 }

deleteForPullRequestComment(options)

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.

Usage

const response = await octokit.reactions.deleteForPullRequestComment({
  owner,
  repo,
  comment_id,
  reaction_id
})

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• reaction_id (required, integer)

Empty response (HTTP 204)

Example

const response = { status: 204 }

deleteForTeamDiscussion(options)

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.

Usage

const response = await octokit.reactions.deleteForTeamDiscussion({
  org,
  team_slug,
  discussion_number,
  reaction_id
})

Options

• org (required, string)
• team_slug (required, string)
• discussion_number (required, integer)
• reaction_id (required, integer)

Empty response (HTTP 204)

Example

const response = { status: 204 }

deleteForTeamDiscussionComment(options)

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.

Usage

const response = await octokit.reactions.deleteForTeamDiscussionComment({
  org,
  team_slug,
  discussion_number,
  comment_number,
  reaction_id
})

Options

• org (required, string)
• team_slug (required, string)
• discussion_number (required, integer)
• comment_number (required, integer)
• reaction_id (required, integer)

Empty response (HTTP 204)

Example

const response = { status: 204 }

deleteLegacy(options)

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.

Usage

const response = await octokit.reactions.deleteLegacy({ reaction_id })

Options

• reaction_id (required, integer)

Empty response (HTTP 204)

Example

const response = { status: 204 }

Error when resource is gone (HTTP 410)

Example

try {
  response = await octokit.reactions.deleteLegacy({ reaction_id })
} catch (err) {
  if (err.status === 410) {
    // ..
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.deleteLegacy({ reaction_id })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

listForCommitComment(options)

List the reactions to a commit comment.

Usage

const response = await octokit.reactions.listForCommitComment({
  owner,
  repo,
  comment_id
})

Fetch all pages

Example

for await (const response of octokit.reactions.listForCommitComment.all({
  owner,
  repo,
  comment_id
})) {
  console.log(response.data)
}

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• content (string): Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
• per_page (integer): Results per page (max 100)
• page (integer): Page number of the results to fetch.

Response (HTTP 200)

Example

const response = {
  status: 200,
  data: [
    {
      id: 1,
      node_id: 'MDg6UmVhY3Rpb24x',
      user: {
        login: 'octocat',
        id: 1,
        node_id: 'MDQ6VXNlcjE=',
        avatar_url: 'https://github.com/images/error/octocat_happy.gif',
        gravatar_id: '',
        url: 'https://api.github.com/users/octocat',
        html_url: 'https://github.com/octocat',
        followers_url: 'https://api.github.com/users/octocat/followers',
        following_url:
          'https://api.github.com/users/octocat/following{/other_user}',
        gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
        starred_url:
          'https://api.github.com/users/octocat/starred{/owner}{/repo}',
        subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
        organizations_url: 'https://api.github.com/users/octocat/orgs',
        repos_url: 'https://api.github.com/users/octocat/repos',
        events_url: 'https://api.github.com/users/octocat/events{/privacy}',
        received_events_url:
          'https://api.github.com/users/octocat/received_events',
        type: 'User',
        site_admin: false
      },
      content: 'heart',
      created_at: '2016-05-20T20:09:31Z'
    }
  ]
}

Error when resource is not found (HTTP 404)

Example

try {
  response = await octokit.reactions.listForCommitComment({
    owner,
    repo,
    comment_id
  })
} catch (err) {
  if (err.status === 404) {
    // ..
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.listForCommitComment({
    owner,
    repo,
    comment_id
  })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

listForIssue(options)

List the reactions to an issue.

Usage

const response = await octokit.reactions.listForIssue({
  owner,
  repo,
  issue_number
})

Fetch all pages

Example

for await (const response of octokit.reactions.listForIssue.all({
  owner,
  repo,
  issue_number
})) {
  console.log(response.data)
}

Options

• owner (required, string)
• repo (required, string)
• issue_number (required, integer)
• content (string): Returns a single reaction type. Omit this parameter to list all reactions to an issue.
• per_page (integer): Results per page (max 100)
• page (integer): Page number of the results to fetch.

Response (HTTP 200)

Example

const response = {
  status: 200,
  data: [
    {
      id: 1,
      node_id: 'MDg6UmVhY3Rpb24x',
      user: {
        login: 'octocat',
        id: 1,
        node_id: 'MDQ6VXNlcjE=',
        avatar_url: 'https://github.com/images/error/octocat_happy.gif',
        gravatar_id: '',
        url: 'https://api.github.com/users/octocat',
        html_url: 'https://github.com/octocat',
        followers_url: 'https://api.github.com/users/octocat/followers',
        following_url:
          'https://api.github.com/users/octocat/following{/other_user}',
        gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
        starred_url:
          'https://api.github.com/users/octocat/starred{/owner}{/repo}',
        subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
        organizations_url: 'https://api.github.com/users/octocat/orgs',
        repos_url: 'https://api.github.com/users/octocat/repos',
        events_url: 'https://api.github.com/users/octocat/events{/privacy}',
        received_events_url:
          'https://api.github.com/users/octocat/received_events',
        type: 'User',
        site_admin: false
      },
      content: 'heart',
      created_at: '2016-05-20T20:09:31Z'
    }
  ]
}

Error when resource is not found (HTTP 404)

Example

try {
  response = await octokit.reactions.listForIssue({ owner, repo, issue_number })
} catch (err) {
  if (err.status === 404) {
    // ..
  }
}

Error when resource is gone (HTTP 410)

Example

try {
  response = await octokit.reactions.listForIssue({ owner, repo, issue_number })
} catch (err) {
  if (err.status === 410) {
    // ..
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.listForIssue({ owner, repo, issue_number })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

listForIssueComment(options)

List the reactions to an issue comment.

Usage

const response = await octokit.reactions.listForIssueComment({
  owner,
  repo,
  comment_id
})

Fetch all pages

Example

for await (const response of octokit.reactions.listForIssueComment.all({
  owner,
  repo,
  comment_id
})) {
  console.log(response.data)
}

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• content (string): Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
• per_page (integer): Results per page (max 100)
• page (integer): Page number of the results to fetch.

Response (HTTP 200)

Example

const response = {
  status: 200,
  data: [
    {
      id: 1,
      node_id: 'MDg6UmVhY3Rpb24x',
      user: {
        login: 'octocat',
        id: 1,
        node_id: 'MDQ6VXNlcjE=',
        avatar_url: 'https://github.com/images/error/octocat_happy.gif',
        gravatar_id: '',
        url: 'https://api.github.com/users/octocat',
        html_url: 'https://github.com/octocat',
        followers_url: 'https://api.github.com/users/octocat/followers',
        following_url:
          'https://api.github.com/users/octocat/following{/other_user}',
        gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
        starred_url:
          'https://api.github.com/users/octocat/starred{/owner}{/repo}',
        subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
        organizations_url: 'https://api.github.com/users/octocat/orgs',
        repos_url: 'https://api.github.com/users/octocat/repos',
        events_url: 'https://api.github.com/users/octocat/events{/privacy}',
        received_events_url:
          'https://api.github.com/users/octocat/received_events',
        type: 'User',
        site_admin: false
      },
      content: 'heart',
      created_at: '2016-05-20T20:09:31Z'
    }
  ]
}

Error when resource is not found (HTTP 404)

Example

try {
  response = await octokit.reactions.listForIssueComment({
    owner,
    repo,
    comment_id
  })
} catch (err) {
  if (err.status === 404) {
    // ..
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.listForIssueComment({
    owner,
    repo,
    comment_id
  })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

listForPullRequestReviewComment(options)

List the reactions to a pull request review comment.

Usage

const response = await octokit.reactions.listForPullRequestReviewComment({
  owner,
  repo,
  comment_id
})

Fetch all pages

Example

for await (const response of octokit.reactions.listForPullRequestReviewComment.all(
  { owner, repo, comment_id }
)) {
  console.log(response.data)
}

Options

• owner (required, string)
• repo (required, string)
• comment_id (required, integer)
• content (string): Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
• per_page (integer): Results per page (max 100)
• page (integer): Page number of the results to fetch.

Response (HTTP 200)

Example

const response = {
  status: 200,
  data: [
    {
      id: 1,
      node_id: 'MDg6UmVhY3Rpb24x',
      user: {
        login: 'octocat',
        id: 1,
        node_id: 'MDQ6VXNlcjE=',
        avatar_url: 'https://github.com/images/error/octocat_happy.gif',
        gravatar_id: '',
        url: 'https://api.github.com/users/octocat',
        html_url: 'https://github.com/octocat',
        followers_url: 'https://api.github.com/users/octocat/followers',
        following_url:
          'https://api.github.com/users/octocat/following{/other_user}',
        gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
        starred_url:
          'https://api.github.com/users/octocat/starred{/owner}{/repo}',
        subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
        organizations_url: 'https://api.github.com/users/octocat/orgs',
        repos_url: 'https://api.github.com/users/octocat/repos',
        events_url: 'https://api.github.com/users/octocat/events{/privacy}',
        received_events_url:
          'https://api.github.com/users/octocat/received_events',
        type: 'User',
        site_admin: false
      },
      content: 'heart',
      created_at: '2016-05-20T20:09:31Z'
    }
  ]
}

Error when resource is not found (HTTP 404)

Example

try {
  response = await octokit.reactions.listForPullRequestReviewComment({
    owner,
    repo,
    comment_id
  })
} catch (err) {
  if (err.status === 404) {
    // ..
  }
}

Error when preview header is missing (HTTP 415)

Example

try {
  response = await octokit.reactions.listForPullRequestReviewComment({
    owner,
    repo,
    comment_id
  })
} catch (err) {
  if (err.status === 415) {
    // ..
  }
}

listForTeamDiscussionCommentInOrg(options)

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.

Usage

const response = await octokit.reactions.listForTeamDiscussionCommentInOrg({
  org,
  team_slug,
  discussion_number,
  comment_number
})

Fetch all pages

Example

for await (const response of octokit.reactions.listForTeamDiscussionCommentInOrg.all(
  { org, team_slug, discussion_number, comment_number }
)) {
  console.log(response.data)
}

Options

• org (required, string)
• team_slug (required, string)
• discussion_number (required, integer)
• comment_number (required, integer)
• content (string): Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
• per_page (integer): Results per page (max 100)
• page (integer): Page number of the results to fetch.

Response (HTTP 200)

Example

const response = {
  status: 200,
  data: [
    {
      id: 1,
      node_id: 'MDg6UmVhY3Rpb24x',
      user: {
        login: 'octocat',
        id: 1,
        node_id: 'MDQ6VXNlcjE=',
        avatar_url: 'https://github.com/images/error/octocat_happy.gif',
        gravatar_id: '',
        url: 'https://api.github.com/users/octocat',
        html_url: 'https://github.com/octocat',
        followers_url: 'https://api.github.com/users/octocat/followers',
        following_url:
          'https://api.github.com/users/octocat/following{/other_user}',
        gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
        starred_url:
          'https://api.github.com/users/octocat/starred{/owner}{/repo}',
        subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
        organizations_url: 'https://api.github.com/users/octocat/orgs',
        repos_url: 'https://api.github.com/users/octocat/repos',
        events_url: 'https://api.github.com/users/octocat/events{/privacy}',
        received_events_url:
          'https://api.github.com/users/octocat/received_events',
        type: 'User',
        site_admin: false
      },
      content: 'heart',
      created_at: '2016-05-20T20:09:31Z'
    }
  ]
}

listForTeamDiscussionInOrg(options)

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.

Usage

const response = await octokit.reactions.listForTeamDiscussionInOrg({
  org,
  team_slug,
  discussion_number
})

Fetch all pages

Example

for await (const response of octokit.reactions.listForTeamDiscussionInOrg.all({
  org,
  team_slug,
  discussion_number
})) {
  console.log(response.data)
}

Options

• org (required, string)
• team_slug (required, string)
• discussion_number (required, integer)
• content (string): Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
• per_page (integer): Results per page (max 100)
• page (integer): Page number of the results to fetch.

Response (HTTP 200)

Example

const response = {
  status: 200,
  data: [
    {
      id: 1,
      node_id: 'MDg6UmVhY3Rpb24x',
      user: {
        login: 'octocat',
        id: 1,
        node_id: 'MDQ6VXNlcjE=',
        avatar_url: 'https://github.com/images/error/octocat_happy.gif',
        gravatar_id: '',
        url: 'https://api.github.com/users/octocat',
        html_url: 'https://github.com/octocat',
        followers_url: 'https://api.github.com/users/octocat/followers',
        following_url:
          'https://api.github.com/users/octocat/following{/other_user}',
        gists_url: 'https://api.github.com/users/octocat/gists{/gist_id}',
        starred_url:
          'https://api.github.com/users/octocat/starred{/owner}{/repo}',
        subscriptions_url: 'https://api.github.com/users/octocat/subscriptions',
        organizations_url: 'https://api.github.com/users/octocat/orgs',
        repos_url: 'https://api.github.com/users/octocat/repos',
        events_url: 'https://api.github.com/users/octocat/events{/privacy}',
        received_events_url:
          'https://api.github.com/users/octocat/received_events',
        type: 'User',
        site_admin: false
      },
      content: 'heart',
      created_at: '2016-05-20T20:09:31Z'
    }
  ]
}