issues

Add assignees to an issue

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

octokit.issues.addAssignees({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
assignees	no	Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

Add labels to an issue

octokit.issues.addLabels({
  owner,
  repo,
  issue_number,
  labels,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
labels	yes	The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.

Check if a user can be assigned

Checks if a user has permission to be assigned to an issue in this repository.

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

Otherwise a 404 status code is returned.

octokit.issues.checkUserCanBeAssigned({
  owner,
  repo,
  assignee,
});

Parameters

name	required	description
owner	yes
repo	yes
assignee	yes

Create an issue

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.issues.create({
  owner,
  repo,
  title,
});

Parameters

name	required	description
owner	yes
repo	yes
title	yes	The title of the issue.
body	no	The contents of the issue.
assignee	no	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.
milestone	no
labels	no	Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.
assignees	no	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.

Create an issue comment

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

octokit.issues.createComment({
  owner,
  repo,
  issue_number,
  body,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
body	yes	The contents of the comment.

Create a label

octokit.issues.createLabel({
  owner,
  repo,
  name,
});

Parameters

name	required	description
owner	yes
repo	yes
name	yes	The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
color	no	The hexadecimal color code for the label, without the leading `#`.
description	no	A short description of the label.

Create a milestone

octokit.issues.createMilestone({
  owner,
  repo,
  title,
});

Parameters

name	required	description
owner	yes
repo	yes
title	yes	The title of the milestone.
state	no	The state of the milestone. Either `open` or `closed`.
description	no	A description of the milestone.
due_on	no	The milestone due date. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

Delete an issue comment

octokit.issues.deleteComment({
  owner,
  repo,
  comment_id,
});

Parameters

name	required	description
owner	yes
repo	yes
comment_id	yes	comment_id parameter

Delete a label

octokit.issues.deleteLabel({
  owner,
  repo,
  name,
});

Parameters

name	required	description
owner	yes
repo	yes
name	yes

Delete a milestone

octokit.issues.deleteMilestone({
  owner,
  repo,
  milestone_number,
});

Parameters

name	required	description
owner	yes
repo	yes
milestone_number	yes	milestone_number parameter

Get an issue

The API returns a 301 Moved Permanently status if the issue wastransferred 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 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe to the issues webhook.

Note: GitHub's REST API v3 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 pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

octokit.issues.get({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter

Get an issue comment

octokit.issues.getComment({
  owner,
  repo,
  comment_id,
});

Parameters

name	required	description
owner	yes
repo	yes
comment_id	yes	comment_id parameter

Get an issue event

octokit.issues.getEvent({
  owner,
  repo,
  event_id,
});

Parameters

name	required	description
owner	yes
repo	yes
event_id	yes

Get a label

octokit.issues.getLabel({
  owner,
  repo,
  name,
});

Parameters

name	required	description
owner	yes
repo	yes
name	yes

Get a milestone

octokit.issues.getMilestone({
  owner,
  repo,
  milestone_number,
});

Parameters

name	required	description
owner	yes
repo	yes
milestone_number	yes	milestone_number parameter

List issues assigned to the authenticated user

List issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not necessarily assigned to you.

octokit.issues.list();

Parameters

name	required	description
filter	no	Indicates which sorts of issues to return. Can be one of: * `assigned`: Issues assigned to you * `created`: Issues created by you * `mentioned`: Issues mentioning you * `subscribed`: Issues you're subscribed to updates for * `all`: All issues the authenticated user can see, regardless of participation or creation
state	no	Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.
labels	no	A list of comma separated label names. Example: `bug,ui,@high`
sort	no	What to sort results by. Can be either `created`, `updated`, `comments`.
direction	no	One of `asc` (ascending) or `desc` (descending).
since	no	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
collab	no
orgs	no
owned	no
pulls	no
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List assignees

Lists the available assignees for issues in a repository.

octokit.issues.listAssignees({
  owner,
  repo,
});

Parameters

name	required	description
owner	yes
repo	yes
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List issue comments

Issue Comments are ordered by ascending ID.

octokit.issues.listComments({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
since	no	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List issue comments for a repository

By default, Issue Comments are ordered by ascending ID.

octokit.issues.listCommentsForRepo({
  owner,
  repo,
});

Parameters

name	required	description
owner	yes
repo	yes
sort	no	One of `created` (when the repository was starred) or `updated` (when it was last pushed to).
direction	no	Either `asc` or `desc`. Ignored without the `sort` parameter.
since	no	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List issue events

octokit.issues.listEvents({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List issue events for a repository

octokit.issues.listEventsForRepo({
  owner,
  repo,
});

Parameters

name	required	description
owner	yes
repo	yes
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List timeline events for an issue

octokit.issues.listEventsForTimeline({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List user account issues assigned to the authenticated user

List issues across owned and member repositories assigned to the authenticated user.

octokit.issues.listForAuthenticatedUser();

Parameters

name	required	description
filter	no	Indicates which sorts of issues to return. Can be one of: * `assigned`: Issues assigned to you * `created`: Issues created by you * `mentioned`: Issues mentioning you * `subscribed`: Issues you're subscribed to updates for * `all`: All issues the authenticated user can see, regardless of participation or creation
state	no	Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.
labels	no	A list of comma separated label names. Example: `bug,ui,@high`
sort	no	What to sort results by. Can be either `created`, `updated`, `comments`.
direction	no	One of `asc` (ascending) or `desc` (descending).
since	no	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List organization issues assigned to the authenticated user

List issues in an organization assigned to the authenticated user.

octokit.issues.listForOrg({
  org,
});

Parameters

name	required	description
org	yes
filter	no	Indicates which sorts of issues to return. Can be one of: * `assigned`: Issues assigned to you * `created`: Issues created by you * `mentioned`: Issues mentioning you * `subscribed`: Issues you're subscribed to updates for * `all`: All issues the authenticated user can see, regardless of participation or creation
state	no	Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.
labels	no	A list of comma separated label names. Example: `bug,ui,@high`
sort	no	What to sort results by. Can be either `created`, `updated`, `comments`.
direction	no	One of `asc` (ascending) or `desc` (descending).
since	no	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List repository issues

List issues in a repository.

octokit.issues.listForRepo({
  owner,
  repo,
});

Parameters

name	required	description
owner	yes
repo	yes
milestone	no	If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.
state	no	Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.
assignee	no	Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.
creator	no	The user that created the issue.
mentioned	no	A user that's mentioned in the issue.
labels	no	A list of comma separated label names. Example: `bug,ui,@high`
sort	no	What to sort results by. Can be either `created`, `updated`, `comments`.
direction	no	One of `asc` (ascending) or `desc` (descending).
since	no	Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List labels for issues in a milestone

octokit.issues.listLabelsForMilestone({
  owner,
  repo,
  milestone_number,
});

Parameters

name	required	description
owner	yes
repo	yes
milestone_number	yes	milestone_number parameter
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List labels for a repository

octokit.issues.listLabelsForRepo({
  owner,
  repo,
});

Parameters

name	required	description
owner	yes
repo	yes
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List labels for an issue

octokit.issues.listLabelsOnIssue({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List milestones

octokit.issues.listMilestones({
  owner,
  repo,
});

Parameters

name	required	description
owner	yes
repo	yes
state	no	The state of the milestone. Either `open`, `closed`, or `all`.
sort	no	What to sort results by. Either `due_on` or `completeness`.
direction	no	The direction of the sort. Either `asc` or `desc`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

Lock an issue

Users with push access can lock an issue or pull request's conversation.

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

octokit.issues.lock({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
lock_reason	no	The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * `off-topic` * `too heated` * `resolved` * `spam`

Remove all labels from an issue

octokit.issues.removeAllLabels({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter

Remove assignees from an issue

Removes one or more assignees from an issue.

octokit.issues.removeAssignees({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
assignees	no	Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

Remove a label from an issue

Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

octokit.issues.removeLabel({
  owner,
  repo,
  issue_number,
  name,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
name	yes

Set labels for an issue

Removes any previous labels and sets the new labels for an issue.

octokit.issues.setLabels({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
labels	no	The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.

Unlock an issue

Users with push access can unlock an issue's conversation.

octokit.issues.unlock({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter

Update an issue

Issue owners and users with push access can edit an issue.

octokit.issues.update({
  owner,
  repo,
  issue_number,
});

Parameters

name	required	description
owner	yes
repo	yes
issue_number	yes	issue_number parameter
title	no	The title of the issue.
body	no	The contents of the issue.
assignee	no	Login for the user that this issue should be assigned to. This field is deprecated.
state	no	State of the issue. Either `open` or `closed`.
milestone	no
labels	no	Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.
assignees	no	Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

Update an issue comment

octokit.issues.updateComment({
  owner,
  repo,
  comment_id,
  body,
});

Parameters

name	required	description
owner	yes
repo	yes
comment_id	yes	comment_id parameter
body	yes	The contents of the comment.

Update a label

octokit.issues.updateLabel({
  owner,
  repo,
  name,
});

Parameters

name	required	description
owner	yes
repo	yes
name	yes
new_name	no	The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
color	no	The hexadecimal color code for the label, without the leading `#`.
description	no	A short description of the label.

Update a milestone

octokit.issues.updateMilestone({
  owner,
  repo,
  milestone_number,
});

Parameters

name	required	description
owner	yes
repo	yes
milestone_number	yes	milestone_number parameter
title	no	The title of the milestone.
state	no	The state of the milestone. Either `open` or `closed`.
description	no	A description of the milestone.
due_on	no	The milestone due date. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

Octokit Rest API

Add assignees to an issue

Parameters

Add labels to an issue

Parameters

Check if a user can be assigned

Parameters

Create an issue

Parameters

Create an issue comment

Parameters

Create a label

Parameters

Create a milestone

Parameters

Delete an issue comment

Parameters

Delete a label

Parameters

Delete a milestone

Parameters

Get an issue

Parameters

Get an issue comment

Parameters

Get an issue event

Parameters

Get a label

Parameters

Get a milestone

Parameters

List issues assigned to the authenticated user

Parameters

List assignees

Parameters

List issue comments

Parameters

List issue comments for a repository

Parameters

List issue events

Parameters

List issue events for a repository

Parameters

List timeline events for an issue

Parameters

List user account issues assigned to the authenticated user

Parameters

List organization issues assigned to the authenticated user

Parameters

List repository issues

Parameters

List labels for issues in a milestone

Parameters

List labels for a repository

Parameters

List labels for an issue

Parameters

List milestones

Parameters

Lock an issue

Parameters

Remove all labels from an issue

Parameters

Remove assignees from an issue

Parameters

Remove a label from an issue

Parameters

Set labels for an issue

Parameters

Unlock an issue

Parameters

Update an issue

Parameters

Update an issue comment

Parameters

Update a label

Parameters

Update a milestone

Parameters