GitHub API (unofficial showcase)

Issues

Interact with GitHub Issues.

Operations

MethodEndpointDescription
GET/issuesList issues assigned to the authenticated user
GET/orgs/{org}/issuesList organization issues assigned to the authenticated user
GET/repos/{owner}/{repo}/assigneesList assignees
GET/repos/{owner}/{repo}/assignees/{assignee}Check if a user can be assigned
GET/repos/{owner}/{repo}/issuesList repository issues
POST/repos/{owner}/{repo}/issuesCreate an issue
GET/repos/{owner}/{repo}/issues/commentsList issue comments for a repository
GET/repos/{owner}/{repo}/issues/comments/{comment_id}Get an issue comment
PATCH/repos/{owner}/{repo}/issues/comments/{comment_id}Update an issue comment
DELETE/repos/{owner}/{repo}/issues/comments/{comment_id}Delete an issue comment
PUT/repos/{owner}/{repo}/issues/comments/{comment_id}/pinPin an issue comment
DELETE/repos/{owner}/{repo}/issues/comments/{comment_id}/pinUnpin an issue comment
GET/repos/{owner}/{repo}/issues/eventsList issue events for a repository
GET/repos/{owner}/{repo}/issues/events/{event_id}Get an issue event
GET/repos/{owner}/{repo}/issues/{issue_number}Get an issue
PATCH/repos/{owner}/{repo}/issues/{issue_number}Update an issue
POST/repos/{owner}/{repo}/issues/{issue_number}/assigneesAdd assignees to an issue
DELETE/repos/{owner}/{repo}/issues/{issue_number}/assigneesRemove assignees from an issue
GET/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}Check if a user can be assigned to a issue
GET/repos/{owner}/{repo}/issues/{issue_number}/commentsList issue comments
POST/repos/{owner}/{repo}/issues/{issue_number}/commentsCreate an issue comment
GET/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_byList dependencies an issue is blocked by
POST/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_byAdd a dependency an issue is blocked by
DELETE/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}Remove dependency an issue is blocked by
GET/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blockingList dependencies an issue is blocking
GET/repos/{owner}/{repo}/issues/{issue_number}/eventsList issue events
GET/repos/{owner}/{repo}/issues/{issue_number}/issue-field-valuesList issue field values for an issue
POST/repos/{owner}/{repo}/issues/{issue_number}/issue-field-valuesAdd issue field values to an issue
PUT/repos/{owner}/{repo}/issues/{issue_number}/issue-field-valuesSet issue field values for an issue
DELETE/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}Delete an issue field value from an issue
GET/repos/{owner}/{repo}/issues/{issue_number}/labelsList labels for an issue
POST/repos/{owner}/{repo}/issues/{issue_number}/labelsAdd labels to an issue
PUT/repos/{owner}/{repo}/issues/{issue_number}/labelsSet labels for an issue
DELETE/repos/{owner}/{repo}/issues/{issue_number}/labelsRemove all labels from an issue
DELETE/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}Remove a label from an issue
PUT/repos/{owner}/{repo}/issues/{issue_number}/lockLock an issue
DELETE/repos/{owner}/{repo}/issues/{issue_number}/lockUnlock an issue
GET/repos/{owner}/{repo}/issues/{issue_number}/parentGet parent issue
DELETE/repos/{owner}/{repo}/issues/{issue_number}/sub_issueRemove sub-issue
GET/repos/{owner}/{repo}/issues/{issue_number}/sub_issuesList sub-issues

The full set of 58 operations is in the API reference.

Example

List issues assigned to the authenticated user, with the TypeScript SDK:

ts
import { GitHubV3REST } from "github";

const client = new GitHubV3REST({
  baseUrl: "https://api.github.com",
});

const result = await client.issues.list();
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.