This API exposes
40 operations
across 24 paths,
and defines 53 schemas.
It is described by OpenAPI 3.2.0, at version 1.1.4.
Requests are made against a single base URL, {protocol}://{hostname}/api/v3.
The identity and technical contract details declared by the specification.
timeline-issue-events
object
Timeline Event
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 required
moved-column-in-project-issue-event
object
Moved Column in Project Issue Event
10 properties
9 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
review-dismissed-issue-event
object
Review Dismissed Issue Event
10 properties
10 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
labeled-issue-event
object
Labeled Issue Event
10 properties
10 required
timeline-reviewed-event
object
Timeline Reviewed Event
14 properties
11 required
simple-user
object
A GitHub user.
21 properties
18 required
scim-error
object
Scim Error
6 properties
demilestoned-issue-event
object
Demilestoned Issue Event
10 properties
10 required
timeline-line-commented-event
object
Timeline Line Commented Event
3 properties
repository
object
A repository on GitHub.
95 properties
73 required
converted-note-to-issue-issue-event
object
Converted Note to Issue Issue Event
10 properties
9 required
assigned-issue-event
object
Assigned Issue Event
11 properties
11 required
added-to-project-issue-event
object
Added to Project Issue Event
10 properties
9 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
commit-comment
object
Commit Comment
14 properties
13 required
issue-event-rename
object
Issue Event Rename
2 properties
2 required
nullable-license-simple
objectnull
License Simple
6 properties
5 required
state-change-issue-event
object
State Change Issue Event
10 properties
9 required
review-request-removed-issue-event
object
Review Request Removed Issue Event
12 properties
10 required
issue-event-milestone
object
Issue Event Milestone
1 property
1 required
validation-error
object
Validation Error
3 properties
2 required
removed-from-project-issue-event
object
Removed from Project Issue Event
10 properties
9 required
timeline-committed-event
object
Timeline Committed Event
11 properties
10 required
reaction-rollup
object
10 properties
10 required
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties
7 required
basic-error
object
Basic Error
4 properties
nullable-milestone
objectnull
A collection of related issues and pull requests.
16 properties
16 required
renamed-issue-event
object
Renamed Issue Event
10 properties
10 required
milestone
object
A collection of related issues and pull requests.
16 properties
16 required
timeline-comment-event
object
Timeline Comment Event
16 properties
11 required
locked-issue-event
object
Locked Issue Event
10 properties
10 required
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
issue-event-dismissed-review
object
4 properties
3 required
timeline-commit-commented-event
object
Timeline Commit Commented Event
4 properties
author-association
string
How the author is associated with the repository.
nullable-issue
objectnull
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
nullable-integration
objectnull
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
timeline-assigned-issue-event
object
Timeline Assigned Issue Event
10 properties
10 required
milestoned-issue-event
object
Milestoned Issue Event
10 properties
10 required
timeline-cross-referenced-event
object
Timeline Cross Referenced Event
5 properties
4 required
unassigned-issue-event
object
Unassigned Issue Event
11 properties
11 required
issue-event-label
object
Issue Event Label
2 properties
2 required
unlabeled-issue-event
object
Unlabeled Issue Event
10 properties
10 required
integration
objectnull
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-for-issue
Issue Event for Issue
timeline-unassigned-issue-event
object
Timeline Unassigned Issue Event
10 properties
10 required
issue-event
object
Issue Event
22 properties
8 required
issue-event-project-card
object
Issue Event Project Card
6 properties
5 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
review-requested-issue-event
object
Review Requested Issue Event
12 properties
10 required
The full machine-readable OpenAPI contract behind this narrative.