How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Issues API

The GitHub Issues API lets you programmatically manage issue tracking on GitHub, enabling you to list and filter issues across repositories, create and edit issues, change their state (open/closed), and manage assignees, labels, and milestones. It supports adding, updating, and deleting comments; applying reactions; locking or unlocking conversations; and viewing issue events and timelines for auditing and automation.

GitHub Issues API is one of 384 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Issues. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 47 operations across 29 paths, and defines 54 schemas. It is described by OpenAPI 3.0.3, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}/api/v3.

47 operations 29 paths 54 schemas 9 DELETE24 GET4 PATCH8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.1.4
Base URL
https://api.github.com/
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Issues API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 47

Across 29 paths, the API surfaces 47 operations — 9 DELETE, 24 GET, 4 PATCH, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Issues 47
GET
/repos/{owner}/{repo}/issues/events/{event_id}
GitHub Get an Issue Event
getAnIssueEvent 3 params → 200403404410
GET
/repos/{owner}/{repo}/issues/comments
GitHub List Issue Comments for Repository
listIssueCommentsForRepository 10 params → 200404422
GET
/repos/{owner}/{repo}/issues/comments/{comment_id}
GitHub Get an Issue Comment
getAnIssueComment 6 params → 200404
PATCH
/repos/{owner}/{repo}/issues/comments/{comment_id}
GitHub Update an Issue Comment
updateAnIssueComment 6 params body → 200422
DELETE
/repos/{owner}/{repo}/issues/comments/{comment_id}
GitHub Delete an Issue Comment
deleteAnIssueComment 6 params → 204
GET
/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions
GitHub List Reactions for an Issue Comment
listReactionsForAnIssueComment 9 params → 200404
POST
/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions
GitHub Create Reaction for an Issue Comment
createReactionForAnIssueComment 6 params body → 200201422
DELETE
/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}
GitHub Delete an Issue Comment Reaction
deleteAnIssueCommentReaction 7 params → 204
GET
/repos/{owner}/{repo}/issues/events
GitHub List Issue Events for Repository
listIssueEventsForRepository 7 params → 200422
GET
/repos/{owner}/{repo}/issues/{issue_number}
GitHub Get an Issue
getAnIssue 6 params → 200301304404410
PATCH
/repos/{owner}/{repo}/issues/{issue_number}
GitHub Update an Issue
updateAnIssue 6 params body → 200301403404410422503
POST
/repos/{owner}/{repo}/issues/{issue_number}/assignees
GitHub Add Assignees to an Issue
addAssigneesToAnIssue 6 params body → 201
DELETE
/repos/{owner}/{repo}/issues/{issue_number}/assignees
GitHub Remove Assignees from an Issue
removeAssigneesFromAnIssue 6 params body → 200
GET
/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}
GitHub Check if User Can Be Assigned to Issue
checkIfUserCanBeAssignedToIssue 7 params → 204404
GET
/repos/{owner}/{repo}/issues/{issue_number}/comments
GitHub List Issue Comments
listIssueComments 9 params → 200404410
POST
/repos/{owner}/{repo}/issues/{issue_number}/comments
GitHub Create an Issue Comment
createAnIssueComment 6 params body → 201403404410422
GET
/repos/{owner}/{repo}/issues/{issue_number}/events
GitHub List Issue Events
listIssueEvents 8 params → 200410
GET
/repos/{owner}/{repo}/issues/{issue_number}/labels
GitHub List Labels for an Issue
listLabelsForAnIssue 8 params → 200301404410
POST
/repos/{owner}/{repo}/issues/{issue_number}/labels
GitHub Add Labels to an Issue
addLabelsToAnIssue 6 params body → 200301404410422
PUT
/repos/{owner}/{repo}/issues/{issue_number}/labels
GitHub Set Labels for an Issue
setLabelsForAnIssue 6 params body → 200301404410422
DELETE
/repos/{owner}/{repo}/issues/{issue_number}/labels
GitHub Remove All Labels from an Issue
removeAllLabelsFromAnIssue 6 params → 204301404410
DELETE
/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}
GitHub Remove Label from an Issue
removeLabelFromAnIssue 7 params → 200301404410
PUT
/repos/{owner}/{repo}/issues/{issue_number}/lock
GitHub Lock an Issue
lockAnIssue 6 params body → 204403404410422
DELETE
/repos/{owner}/{repo}/issues/{issue_number}/lock
GitHub Unlock an Issue
unlockAnIssue 6 params → 204403404
GET
/repos/{owner}/{repo}/issues/{issue_number}/reactions
GitHub List Reactions for an Issue
listReactionsForAnIssue 9 params → 200404410
POST
/repos/{owner}/{repo}/issues/{issue_number}/reactions
GitHub Create Reaction for an Issue
createReactionForAnIssue 6 params body → 200201422
DELETE
/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}
GitHub Delete an Issue Reaction
deleteAnIssueReaction 7 params → 204
GET
/repos/{owner}/{repo}/issues/{issue_number}/timeline
GitHub List Timeline Events for an Issue
listTimelineEventsForAnIssue 8 params → 200404410
GET
/issues
GitHub List Issues Assigned to the Authenticated User
issues/list 12 params → 200304404422
GET
/orgs/{org}/issues
GitHub List Organization Issues Assigned to the Authenticated User
issues/list-for-org 9 params → 200404
GET
/repos/{owner}/{repo}/assignees
GitHub List Assignees
issues/list-assignees 4 params → 200404
GET
/repos/{owner}/{repo}/assignees/{assignee}
GitHub Check if a User Can Be Assigned
issues/check-user-can-be-assigned 3 params → 204404
GET
/repos/{owner}/{repo}/issues
GitHub List Repository Issues
issues/list-for-repo 13 params → 200301404422
POST
/repos/{owner}/{repo}/issues
GitHub Create an Issue
issues/create 2 params body → 201400403404410422503
GET
/repos/{owner}/{repo}/labels
GitHub List Labels for a Repository
issues/list-labels-for-repo 4 params → 200404
POST
/repos/{owner}/{repo}/labels
GitHub Create a Label
issues/create-label 2 params body → 201404422
GET
/repos/{owner}/{repo}/labels/{name}
GitHub Get a Label
issues/get-label 3 params → 200404
PATCH
/repos/{owner}/{repo}/labels/{name}
GitHub Update a Label
issues/update-label 3 params body → 200
DELETE
/repos/{owner}/{repo}/labels/{name}
GitHub Delete a Label
issues/delete-label 3 params → 204
GET
/repos/{owner}/{repo}/milestones
GitHub List Milestones
issues/list-milestones 7 params → 200404
POST
/repos/{owner}/{repo}/milestones
GitHub Create a Milestone
issues/create-milestone 2 params body → 201404422
GET
/repos/{owner}/{repo}/milestones/{milestone_number}
GitHub Get a Milestone
issues/get-milestone 3 params → 200404
PATCH
/repos/{owner}/{repo}/milestones/{milestone_number}
GitHub Update a Milestone
issues/update-milestone 3 params body → 200
DELETE
/repos/{owner}/{repo}/milestones/{milestone_number}
GitHub Delete a Milestone
issues/delete-milestone 3 params → 204404
GET
/repos/{owner}/{repo}/milestones/{milestone_number}/labels
GitHub List Labels for Issues in a Milestone
issues/list-labels-for-milestone 5 params → 200
GET
/user/issues
GitHub List User Account Issues Assigned to the Authenticated User
issues/list-for-authenticated-user 8 params → 200304404
GET
/search/issues
GitHub Search Issues and Pull Requests
searchIssuesAndPullRequests 8 params → 200304403422503

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), issue (34 properties), nullable-issue (34 properties), pull-request-review-comment (29 properties). Each schema is shown below with its type and property counts.

nullable-simple-user
object
A GitHub user.
21 properties 18 required
integration
object
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…
17 properties 11 required
repository
object
A repository on GitHub.
95 properties 73 required
nullable-milestone
object
A collection of related issues and pull requests.
16 properties 16 required
reaction-rollup
object
10 properties 10 required
milestone
object
A collection of related issues and pull requests.
16 properties 16 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
unlabeled-issue-event
object
Unlabeled Issue Event
10 properties 10 required
timeline-cross-referenced-event
object
Timeline Cross Referenced Event
5 properties 4 required
added-to-project-issue-event
object
Added to Project Issue Event
10 properties 9 required
issue-event-label
object
Issue Event Label
2 properties 2 required
converted-note-to-issue-issue-event
object
Converted Note to Issue Issue Event
10 properties 9 required
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties 7 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties 9 required
basic-error
object
Basic Error
4 properties
labeled-issue-event
object
Labeled Issue Event
10 properties 10 required
timeline-comment-event
object
Timeline Comment Event
16 properties 11 required
moved-column-in-project-issue-event
object
Moved Column in Project Issue Event
10 properties 9 required
review-request-removed-issue-event
object
Review Request Removed Issue Event
12 properties 10 required
issue-event
object
Issue Event
22 properties 8 required
scim-error
object
Scim Error
6 properties
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties 21 required
nullable-issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties 21 required
timeline-unassigned-issue-event
object
Timeline Unassigned Issue Event
10 properties 10 required
locked-issue-event
object
Locked Issue Event
10 properties 10 required
issue-event-milestone
object
Issue Event Milestone
1 property 1 required
issue-event-project-card
object
Issue Event Project Card
6 properties 5 required
timeline-commit-commented-event
object
Timeline Commit Commented Event
4 properties
commit-comment
object
Commit Comment
14 properties 13 required
assigned-issue-event
object
Assigned Issue Event
11 properties 11 required
review-dismissed-issue-event
object
Review Dismissed Issue Event
10 properties 10 required
removed-from-project-issue-event
object
Removed from Project Issue Event
10 properties 9 required
review-requested-issue-event
object
Review Requested Issue Event
12 properties 10 required
state-change-issue-event
object
State Change Issue Event
10 properties 9 required
validation-error
object
Validation Error
3 properties 2 required
timeline-committed-event
object
Timeline Committed Event
11 properties 10 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties 16 required
renamed-issue-event
object
Renamed Issue Event
10 properties 10 required
issue-event-for-issue
Issue Event for Issue
issue-event-dismissed-review
object
4 properties 3 required
timeline-assigned-issue-event
object
Timeline Assigned Issue Event
10 properties 10 required
unassigned-issue-event
object
Unassigned Issue Event
11 properties 11 required
nullable-integration
object
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…
17 properties 11 required
issue-event-rename
object
Issue Event Rename
2 properties 2 required
demilestoned-issue-event
object
Demilestoned Issue Event
10 properties 10 required
timeline-issue-events
object
Timeline Event
timeline-reviewed-event
object
Timeline Reviewed Event
14 properties 11 required
simple-user
object
A GitHub user.
21 properties 18 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
milestoned-issue-event
object
Milestoned Issue Event
10 properties 10 required
nullable-license-simple
object
License Simple
6 properties 5 required
author-association
string
How the author is associated with the repository.
timeline-line-commented-event
object
Timeline Line Commented Event
3 properties
reaction
object
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-issues-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
GitHub User API
Where this information came from

This is an independent, third-party profile of GitHub Issues API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.