← All tags

Issues API Reference

Interact with GitHub Issues.

55 endpoints tagged issues, each listing its parameters and possible responses. Search or scroll the index below to jump to a specific endpoint.

No endpoints match your search.

List issues assigned to the authenticated user

GET /issues

List issues assigned to the authenticated user across all visible repositories including owned repositories, member

Parameters

Name	In	Required	Description
`filter`	query	no	Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.
`state`	query	no	Indicates the state of the issues to return.
`labels`	query	no	A list of comma separated label names. Example: `bug,ui,@high`
`sort`	query	no	What to sort results by.
`direction`	query	no	The direction to sort the results by.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`collab`	query	no
`orgs`	query	no
`owned`	query	no
`pulls`	query	no
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes
304	Not modified	no
404	Resource not found	yes

List organization issues assigned to the authenticated user

GET /orgs/{org}/issues

List issues in an organization assigned to the authenticated user.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.
`filter`	query	no	Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.
`state`	query	no	Indicates the state of the issues to return.
`labels`	query	no	A list of comma separated label names. Example: `bug,ui,@high`
`type`	query	no	Can be the name of an issue type.
`sort`	query	no	What to sort results by.
`direction`	query	no	The direction to sort the results by.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

List assignees

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

Lists the available assignees for issues in a repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

Check if a user can be assigned

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

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`assignee`	path	yes

Responses

Status	Description	Has JSON body
204	If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.	no
404	Otherwise a `404` status code is returned.	yes

List repository issues

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

List issues in a repository. Only open issues will be listed.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`milestone`	query	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`	query	no	Indicates the state of the issues to return.
`assignee`	query	no	Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.
`type`	query	no	Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.
`creator`	query	no	The user that created the issue.
`mentioned`	query	no	A user that's mentioned in the issue.
`issue_field_values`	query	no	A comma-separated list of issue field filters in `field_slug:value` format.
`labels`	query	no	A list of comma separated label names. Example: `bug,ui,@high`
`sort`	query	no	What to sort results by.
`direction`	query	no	The direction to sort the results by.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
422	Validation failed, or the endpoint has been spammed.	yes
404	Resource not found	yes

Create an issue

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

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.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	Response	yes
400	Bad Request	yes
403	Forbidden	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes
404	Resource not found	yes
410	Gone	yes

List issue comments for a repository

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

You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`sort`	query	no	The property to sort the results by.
`direction`	query	no	Either `asc` or `desc`. Ignored without the `sort` parameter.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes
404	Resource not found	yes

Get an issue comment

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

You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`comment_id`	path	yes	The unique identifier of the comment.

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

Update an issue comment

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

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`comment_id`	path	yes	The unique identifier of the comment.

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes

Delete an issue comment

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

You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`comment_id`	path	yes	The unique identifier of the comment.

Responses

Status	Description	Has JSON body
204	Response	no

Pin an issue comment

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

You can use the REST API to pin comments on issues.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`comment_id`	path	yes	The unique identifier of the comment.

Responses

Status	Description	Has JSON body
200	Response	yes
401	Requires authentication	yes
403	Forbidden	yes
404	Resource not found	yes
410	Gone	yes
422	Validation failed, or the endpoint has been spammed.	yes

Unpin an issue comment

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

You can use the REST API to unpin comments on issues.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`comment_id`	path	yes	The unique identifier of the comment.

Responses

Status	Description	Has JSON body
204	Response	no
401	Requires authentication	yes
403	Forbidden	yes
404	Resource not found	yes
410	Gone	yes
503	Service unavailable	yes

List issue events for a repository

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

Lists events for a repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes

Get an issue event

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

Gets a single event by the event id.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`event_id`	path	yes

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes
410	Gone	yes
403	Forbidden	yes

Get an issue

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

The API returns a 301 Moved Permanently status if the issue was

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes
304	Not modified	no

Update an issue

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

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes
403	Forbidden	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

Add assignees to an issue

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

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
201	Response	yes

Remove assignees from an issue

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

Removes one or more assignees from an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes

Check if a user can be assigned to a issue

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

Checks if a user has permission to be assigned to a specific issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`assignee`	path	yes

Responses

Status	Description	Has JSON body
204	Response if `assignee` can be assigned to `issue_number`	no
404	Response if `assignee` can not be assigned to `issue_number`	yes

List issue comments

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

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes
410	Gone	yes

Create an issue comment

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

You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
201	Response	yes
403	Forbidden	yes
410	Gone	yes
422	Validation failed, or the endpoint has been spammed.	yes
404	Resource not found	yes

List dependencies an issue is blocked by

GET /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by

You can use the REST API to list the dependencies an issue is blocked by.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

Add a dependency an issue is blocked by

POST /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by

You can use the REST API to add a 'blocked by' relationship to an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
201	Response	yes
301	Moved permanently	yes
403	Forbidden	yes
410	Gone	yes
422	Validation failed, or the endpoint has been spammed.	yes
404	Resource not found	yes

Remove dependency an issue is blocked by

DELETE /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}

You can use the REST API to remove a dependency that an issue is blocked by.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`issue_id`	path	yes	The id of the blocking issue to remove as a dependency

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
400	Bad Request	yes
401	Requires authentication	yes
403	Forbidden	yes
404	Resource not found	yes
410	Gone	yes

List dependencies an issue is blocking

GET /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking

You can use the REST API to list the dependencies an issue is blocking.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

List issue events

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

Lists all events for an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
410	Gone	yes

List issue field values for an issue

GET /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values

Lists all issue field values for an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

Add issue field values to an issue

POST /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
400	Bad Request	yes
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes

Set issue field values for an issue

PUT /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
400	Bad Request	yes
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes

Delete an issue field value from an issue

DELETE /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}

Remove a specific custom field value from an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`issue_field_id`	path	yes	The unique identifier of the issue field.

Responses

Status	Description	Has JSON body
204	Issue field value deleted successfully	no
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes

List labels for an issue

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

Lists all labels for an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

Add labels to an issue

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

Adds labels to an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes
422	Validation failed, or the endpoint has been spammed.	yes

Set labels for an issue

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

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes
422	Validation failed, or the endpoint has been spammed.	yes

Remove all labels from an issue

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

Removes all labels from an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
204	Response	no
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

Remove a label from an issue

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

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.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`name`	path	yes

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

Lock an issue

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

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
204	Response	no
403	Forbidden	yes
410	Gone	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Unlock an issue

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

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
204	Response	no
403	Forbidden	yes
404	Resource not found	yes

Get parent issue

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

You can use the REST API to get the parent issue of a sub-issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
301	Moved permanently	yes
404	Resource not found	yes
410	Gone	yes

Remove sub-issue

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

You can use the REST API to remove a sub-issue from an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
400	Bad Request	yes
404	Resource not found	yes

List sub-issues

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

You can use the REST API to list the sub-issues on an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes
410	Gone	yes

Add sub-issue

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

You can use the REST API to add sub-issues to issues.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
201	Response	yes
403	Forbidden	yes
410	Gone	yes
422	Validation failed, or the endpoint has been spammed.	yes
404	Resource not found	yes

Reprioritize sub-issue

PATCH /repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority

You can use the REST API to reprioritize a sub-issue to a different position in the parent list.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.

Responses

Status	Description	Has JSON body
200	Response	yes
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes

List timeline events for an issue

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

List all timeline events for an issue.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`issue_number`	path	yes	The number that identifies the issue.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes
400	Bad Request	yes
410	Gone	yes

List labels for a repository

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

Lists all labels for a repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

Create a label

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

Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes
404	Resource not found	yes

Get a label

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

Gets a label using the given name.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`name`	path	yes

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

Update a label

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

Updates a label using the given label name.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`name`	path	yes

Responses

Status	Description	Has JSON body
200	Response	yes

Delete a label

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

Deletes a label using the given label name.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`name`	path	yes

Responses

Status	Description	Has JSON body
204	Response	no

List milestones

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

Lists milestones for a repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`state`	query	no	The state of the milestone. Either `open`, `closed`, or `all`.
`sort`	query	no	What to sort results by. Either `due_on` or `completeness`.
`direction`	query	no	The direction of the sort. Either `asc` or `desc`.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

Create a milestone

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

Creates a milestone.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	Response	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Get a milestone

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

Gets a milestone using the given milestone number.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`milestone_number`	path	yes	The number that identifies the milestone.

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

Update a milestone

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`milestone_number`	path	yes	The number that identifies the milestone.

Responses

Status	Description	Has JSON body
200	Response	yes

Delete a milestone

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

Deletes a milestone using the given milestone number.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`milestone_number`	path	yes	The number that identifies the milestone.

Responses

Status	Description	Has JSON body
204	Response	no
404	Resource not found	yes

List labels for issues in a milestone

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

Lists labels for issues in a milestone.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`milestone_number`	path	yes	The number that identifies the milestone.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List user account issues assigned to the authenticated user

GET /user/issues

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

Parameters

Name	In	Required	Description
`filter`	query	no	Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.
`state`	query	no	Indicates the state of the issues to return.
`labels`	query	no	A list of comma separated label names. Example: `bug,ui,@high`
`sort`	query	no	What to sort results by.
`direction`	query	no	The direction to sort the results by.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes
304	Not modified	no