GitHub v3 REST API

List reactions for an issue

List the reactions to an issue.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/{issue_number}/reactions

Query Parameters

contentstring

Returns a single reaction type. Omit this parameter to list all reactions to an issue.

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

ownerstringrequired
repostringrequired
issue_numberintegerrequired

issue_number parameter

Response

application/json

Response

Reactions to conversations provide a way to help people express their feelings more simply and effectively.

idintegerrequired

Example:1

node_idstringrequired

Example:MDg6UmVhY3Rpb24x

userobject | nullrequired

Simple User

Show Child Parameters
contentstringrequired

The reaction to use

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

Example:heart

created_atstring(date-time)required

Example:2016-05-20T20:09:31Z

get/repos/{owner}/{repo}/issues/{issue_number}/reactions
 
curl --request GET \
  --url 'http://hostname/api/v3/repos///issues//reactions?per_page=30&page=1' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
[
  {
    "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"
  }
]

Create reaction for an issue

Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/{issue_number}/reactions

Path Parameters

ownerstringrequired
repostringrequired
issue_numberintegerrequired

issue_number parameter

Body

application/json
contentstringrequired

The reaction type to add to the issue.

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

Response

application/json

Response

Reaction

Reactions to conversations provide a way to help people express their feelings more simply and effectively.

idintegerrequired

Example:1

node_idstringrequired

Example:MDg6UmVhY3Rpb24x

userobject | nullrequired

Simple User

Show Child Parameters
contentstringrequired

The reaction to use

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

Example:heart

created_atstring(date-time)required

Example:2016-05-20T20:09:31Z

post/repos/{owner}/{repo}/issues/{issue_number}/reactions

Body

{
  "content": "heart"
}
{ "content": "heart" }
 
curl --request POST \
  --url http://hostname/api/v3/repos///issues//reactions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "heart"
}'
application/json
{
  "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"
}

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.

delete
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}

Path Parameters

ownerstringrequired
repostringrequired
issue_numberintegerrequired

issue_number parameter

reaction_idintegerrequired

Response

204

Response

delete/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}
 
curl --request DELETE \
  --url http://hostname/api/v3/repos///issues//reactions/ \
  --header 'Content-Type: application/json'
204
Response

List reactions for a pull request review comment

List the reactions to a pull request review comment.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions

Query Parameters

contentstring

Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

ownerstringrequired
repostringrequired
comment_idintegerrequired

comment_id parameter

Response

application/json

Response

Reactions to conversations provide a way to help people express their feelings more simply and effectively.

idintegerrequired

Example:1

node_idstringrequired

Example:MDg6UmVhY3Rpb24x

userobject | nullrequired

Simple User

Show Child Parameters
contentstringrequired

The reaction to use

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

Example:heart

created_atstring(date-time)required

Example:2016-05-20T20:09:31Z

get/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions
 
curl --request GET \
  --url 'http://hostname/api/v3/repos///pulls/comments//reactions?per_page=30&page=1' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
application/json
[
  {
    "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"
  }
]

Create reaction for a pull request review comment

Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions

Path Parameters

ownerstringrequired
repostringrequired
comment_idintegerrequired

comment_id parameter

Body

application/json
contentstringrequired

The reaction type to add to the pull request review comment.

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

Response

application/json

Reaction exists

Reaction

Reactions to conversations provide a way to help people express their feelings more simply and effectively.

idintegerrequired

Example:1

node_idstringrequired

Example:MDg6UmVhY3Rpb24x

userobject | nullrequired

Simple User

Show Child Parameters
contentstringrequired

The reaction to use

Allowed values:+1-1laughconfusedhearthoorayrocketeyes

Example:heart

created_atstring(date-time)required

Example:2016-05-20T20:09:31Z

post/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions

Body

{
  "content": "heart"
}
{ "content": "heart" }
 
curl --request POST \
  --url http://hostname/api/v3/repos///pulls/comments//reactions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "heart"
}'
application/json
{
  "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"
}