Check if a user can be assigned
Checks if a user has permission to be assigned to an issue in this repository.
If the assignee
can be assigned to issues in the repository, a 204
header with no content is returned.
Otherwise a 404
status code is returned.
Path Parameters
Response
Response
If the assignee
can be assigned to issues in the repository, a 204
header with no content is returned.
Path Parameters
List repository issues
List issues in a repository.
Note: GitHub’s REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, “Issues” endpoints may return both issues and pull requests in the response. You can identify pull requests by
the pull_request
key. Be aware that the id
of a pull request returned from “Issues” endpoints will be an issue id. To find out the pull
request id, use the “List pull requests” endpoint.
Query Parameters
If an integer
is passed, it should refer to a milestone by its number
field. If the string *
is passed, issues with any milestone are accepted. If the string none
is passed, issues without milestones are returned.
Indicates the state of the issues to return. Can be either open
, closed
, or all
.
Allowed values:openclosedall
Default:open
Can be the name of a user. Pass in none
for issues with no assigned user, and *
for issues assigned to any user.
The user that created the issue.
A user that’s mentioned in the issue.
A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created
, updated
, comments
.
Allowed values:createdupdatedcomments
Default:created
One of asc
(ascending) or desc
(descending).
Allowed values:ascdesc
Default:desc
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
Response
application/json
Response
Response
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
URL for the issue
Example:https://api.github.com/repositories/42/issues/1
Number uniquely identifying the issue within its repository
Example:42
State of the issue; either ‘open’ or ‘closed’
Example:open
Title of the issue
Example:Widget creation fails in Safari on OS X 10.8
Contents of the issue
Example:It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
Simple User
Show Child Parameters
One Of
Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
Example:["bug","registration"]
Simple User
Show Child Parameters
Simple User
Show Child Parameters
A collection of related issues and pull requests.
Show Child Parameters
Show Child Parameters
Simple User
Show Child Parameters
A git repository
Show Child Parameters
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.
Show Child Parameters
How the author is associated with the repository.
Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
Example:OWNER
Show Child Parameters
Path Parameters
Query Parameters
Create an issue
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone
status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
Path Parameters
Body
application/json
Body
One Of
The title of the issue.
The contents of the issue.
Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
One Of
One Of
Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.
Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
Response
application/json
Response
Response
Issue
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
URL for the issue
Example:https://api.github.com/repositories/42/issues/1
Number uniquely identifying the issue within its repository
Example:42
State of the issue; either ‘open’ or ‘closed’
Example:open
Title of the issue
Example:Widget creation fails in Safari on OS X 10.8
Contents of the issue
Example:It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
Simple User
Show Child Parameters
One Of
Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
Example:["bug","registration"]
Simple User
Show Child Parameters
Simple User
Show Child Parameters
A collection of related issues and pull requests.
Show Child Parameters
Show Child Parameters
Simple User
Show Child Parameters
A git repository
Show Child Parameters
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.
Show Child Parameters
How the author is associated with the repository.
Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
Example:OWNER
Show Child Parameters
Path Parameters
Body
List issue comments for a repository
By default, Issue Comments are ordered by ascending ID.
Query Parameters
One of created
(when the repository was starred) or updated
(when it was last pushed to).
Allowed values:createdupdated
Default:created
Either asc
or desc
. Ignored without the sort
parameter.
Allowed values:ascdesc
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Path Parameters
Response
application/json
Response
Response
Comments provide a way for people to collaborate on an issue.
Unique identifier of the issue comment
Example:42
URL for the issue comment
Example:https://api.github.com/repositories/42/issues/comments/1
Contents of the issue comment
Example:What version of Safari were you using when you observed this bug?
Simple User
Show Child Parameters
Example:2011-04-14T16:00:49Z
Example:2011-04-14T16:00:49Z
How the author is associated with the repository.
Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
Example:OWNER
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.
Show Child Parameters
Show Child Parameters
Path Parameters
Query Parameters
Get an issue comment
Path Parameters
comment_id parameter
Response
application/json
Response
Response
Issue Comment
Comments provide a way for people to collaborate on an issue.
Unique identifier of the issue comment
Example:42
URL for the issue comment
Example:https://api.github.com/repositories/42/issues/comments/1
Contents of the issue comment
Example:What version of Safari were you using when you observed this bug?
Simple User
Show Child Parameters
Example:2011-04-14T16:00:49Z
Example:2011-04-14T16:00:49Z
How the author is associated with the repository.
Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
Example:OWNER
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.