APIs.io Engineering Platform Issues API

Interact with GitHub Issues.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 40 operations across 24 paths, and defines 53 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

40 operations 24 paths 53 schemas 7 DELETE21 GET4 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Issues API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 40

Across 24 paths, the API surfaces 40 operations — 7 DELETE, 21 GET, 4 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Issues 40

Interact with GitHub Issues.

GET

/issues

APIs.io Engineering Platform List issues assigned to the authenticated user

issues/list 12 params → 200422304404

GET

/orgs/{org}/issues

APIs.io Engineering Platform List organization issues assigned to the authenticated user

issues/list-for-org 9 params → 200404

GET

/repos/{owner}/{repo}/assignees

APIs.io Engineering Platform List assignees

issues/list-assignees 4 params → 200404

GET

/repos/{owner}/{repo}/assignees/{assignee}

APIs.io Engineering Platform Check if a user can be assigned

issues/check-user-can-be-assigned 3 params → 204404

GET

/repos/{owner}/{repo}/issues

APIs.io Engineering Platform List repository issues

issues/list-for-repo 13 params → 200301422404

POST

/repos/{owner}/{repo}/issues

APIs.io Engineering Platform Create an issue

issues/create 2 params body → 201400403422503404410

GET

/repos/{owner}/{repo}/issues/comments

APIs.io Engineering Platform List issue comments for a repository

issues/list-comments-for-repo 7 params → 200422404

GET

/repos/{owner}/{repo}/issues/comments/{comment_id}

APIs.io Engineering Platform Get an issue comment

issues/get-comment 3 params → 200404

PATCH

/repos/{owner}/{repo}/issues/comments/{comment_id}

APIs.io Engineering Platform Update an issue comment

issues/update-comment 3 params body → 200422

DELETE

/repos/{owner}/{repo}/issues/comments/{comment_id}

APIs.io Engineering Platform Delete an issue comment

issues/delete-comment 3 params → 204

GET

/repos/{owner}/{repo}/issues/events

APIs.io Engineering Platform List issue events for a repository

issues/list-events-for-repo 4 params → 200422

GET

/repos/{owner}/{repo}/issues/events/{event_id}

APIs.io Engineering Platform Get an issue event

issues/get-event 3 params → 200404410403

GET

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

APIs.io Engineering Platform Get an issue

issues/get 3 params → 200301404410304

PATCH

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

APIs.io Engineering Platform Update an issue

issues/update 3 params body → 200422503403301404410

POST

/repos/{owner}/{repo}/issues/{issue_number}/assignees

APIs.io Engineering Platform Add assignees to an issue

issues/add-assignees 3 params body → 201

DELETE

/repos/{owner}/{repo}/issues/{issue_number}/assignees

APIs.io Engineering Platform Remove assignees from an issue

issues/remove-assignees 3 params body → 200

GET

/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}

APIs.io Engineering Platform Check if a user can be assigned to a issue

issues/check-user-can-be-assigned-to-issue 4 params → 204404

GET

/repos/{owner}/{repo}/issues/{issue_number}/comments

APIs.io Engineering Platform List issue comments

issues/list-comments 6 params → 200404410

POST

/repos/{owner}/{repo}/issues/{issue_number}/comments

APIs.io Engineering Platform Create an issue comment

issues/create-comment 3 params body → 201403410422404

GET

/repos/{owner}/{repo}/issues/{issue_number}/events

APIs.io Engineering Platform List issue events

issues/list-events 5 params → 200410

GET

/repos/{owner}/{repo}/issues/{issue_number}/labels

APIs.io Engineering Platform List labels for an issue

issues/list-labels-on-issue 5 params → 200301404410

POST

/repos/{owner}/{repo}/issues/{issue_number}/labels

APIs.io Engineering Platform Add labels to an issue

issues/add-labels 3 params body → 200301404410422

PUT

/repos/{owner}/{repo}/issues/{issue_number}/labels

APIs.io Engineering Platform Set labels for an issue

issues/set-labels 3 params body → 200301404410422

DELETE

/repos/{owner}/{repo}/issues/{issue_number}/labels

APIs.io Engineering Platform Remove all labels from an issue

issues/remove-all-labels 3 params → 204301404410

DELETE

/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}

APIs.io Engineering Platform Remove a label from an issue

issues/remove-label 4 params → 200301404410

PUT

/repos/{owner}/{repo}/issues/{issue_number}/lock

APIs.io Engineering Platform Lock an issue

issues/lock 3 params body → 204403410404422

DELETE

/repos/{owner}/{repo}/issues/{issue_number}/lock

APIs.io Engineering Platform Unlock an issue

issues/unlock 3 params → 204403404

GET

/repos/{owner}/{repo}/issues/{issue_number}/timeline

APIs.io Engineering Platform List timeline events for an issue

issues/list-events-for-timeline 5 params → 200404410

GET

/repos/{owner}/{repo}/labels

APIs.io Engineering Platform List labels for a repository

issues/list-labels-for-repo 4 params → 200404

POST

/repos/{owner}/{repo}/labels

APIs.io Engineering Platform Create a label

issues/create-label 2 params body → 201422404

GET

/repos/{owner}/{repo}/labels/{name}

APIs.io Engineering Platform Get a label

issues/get-label 3 params → 200404

PATCH

/repos/{owner}/{repo}/labels/{name}

APIs.io Engineering Platform Update a label

issues/update-label 3 params body → 200

DELETE

/repos/{owner}/{repo}/labels/{name}

APIs.io Engineering Platform Delete a label

issues/delete-label 3 params → 204

GET

/repos/{owner}/{repo}/milestones

APIs.io Engineering Platform List milestones

issues/list-milestones 7 params → 200404

POST

/repos/{owner}/{repo}/milestones

APIs.io Engineering Platform Create a milestone

issues/create-milestone 2 params body → 201404422

GET

/repos/{owner}/{repo}/milestones/{milestone_number}

APIs.io Engineering Platform Get a milestone

issues/get-milestone 3 params → 200404

PATCH

/repos/{owner}/{repo}/milestones/{milestone_number}

APIs.io Engineering Platform Update a milestone

issues/update-milestone 3 params body → 200

DELETE

/repos/{owner}/{repo}/milestones/{milestone_number}

APIs.io Engineering Platform Delete a milestone

issues/delete-milestone 3 params → 204404

GET

/repos/{owner}/{repo}/milestones/{milestone_number}/labels

APIs.io Engineering Platform List labels for issues in a milestone

issues/list-labels-for-milestone 5 params → 200

GET

/user/issues

APIs.io Engineering Platform List user account issues assigned to the authenticated user

issues/list-for-authenticated-user 8 params → 200404304

Schemas 53

The contract defines 53 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Issues

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Issues API

Metadata

Authentication & Security 1

Paths & Operations 40

Schemas 53

Specification

Source

API Details

Provider

Explore more