Issues

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Actions

Enter a search term to find it in the GitHub Docs.

Issues - GitHub AE Docs

Use the REST API to view and manage issues, including issue assignees, comments, labels, and milestones.

Quickstart

Comparing GitHub's APIs

Resources in the REST API

Rate limits

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Branches

Protected branches

Check Runs

Check Suites

Checks

Code Scanning

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

License

Organizations

Pre-receive Environments

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Followers

GPG Keys

Git SSH Keys

v1.0

https://web.archive.org/web/20231125084024/https://api.github.com/repos/octocat/Hello-World/contents/{+path}

Hello-World

Found a bug

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.

Issue

List issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not
necessarily assigned to you.
Note: GitHub's REST API 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 <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "<a href="https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests">List pull requests</a>" endpoint.

Indicates which sorts of issues to return. <code>assigned</code> means issues assigned to you. <code>created</code> means issues created by you. <code>mentioned</code> means issues mentioning you. <code>subscribed</code> means issues you're subscribed to updates for. <code>all</code> or <code>repos</code> means all issues you can see, regardless of participation or creation.

filter

Indicates the state of the issues to return.

state

A list of comma separated label names. Example: <code>bug,ui,@high</code>

labels

sort

The direction to sort the results by.

direction

Only show results that were last updated after the given time. This is a timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.

since

collab

orgs

owned

pulls

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

Validation failed, or the endpoint has been spammed.

List issues assigned to the authenticated user

List issues in an organization assigned to the authenticated user.
Note: GitHub's REST API 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 <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "<a href="https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests">List pull requests</a>" endpoint.

The organization name. The name is not case sensitive.

List organization issues assigned to the authenticated user

List issues in a repository. Only open issues will be listed.
Note: GitHub's REST API 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 <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "<a href="https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests">List pull requests</a>" endpoint.

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

If an <code>integer</code> is passed, it should refer to a milestone by its <code>number</code> field. If the string <code>*</code> is passed, issues with any milestone are accepted. If the string <code>none</code> is passed, issues without milestones are returned.

milestone

Can be the name of a user. Pass in <code>none</code> for issues with no assigned user, and <code>*</code> for issues assigned to any user.

assignee

creator

A user that's mentioned in the issue.

mentioned

List repository issues

title

body

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.

The <code>number</code> of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

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.

assignees

How the author is associated with the repository.

author_association

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

Number uniquely identifying the issue within its repository

Reaction Rollup

Repository

State of the issue; either 'open' or 'closed'

Any user with pull access to a repository can create an issue. If <a href="https://docs.github.com/github-ae@latest/articles/disabling-issues/">issues are disabled in the repository</a>, the API returns a <code>410 Gone</code> status.
This endpoint triggers <a href="https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits">Rate limits for the API</a>"
and "<a href="https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api">Best practices for using the REST API</a>."

Create an issue

The API returns a <a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-redirects-redirects"><code>301 Moved Permanently</code> status</a> if the issue was
<a href="https://docs.github.com/github-ae@latest/articles/transferring-an-issue-to-another-repository/">transferred</a> to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe
to the <a href="https://docs.github.com/github-ae@latest/webhooks/event-payloads/#issues"><code>issues</code></a> webhook.
Note: GitHub's REST API 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 <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "<a href="https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests">List pull requests</a>" endpoint.

The number that identifies the issue.

issue_number

Get an issue