Issue¶

Issues are used to track defects, requirements, and discussions. Through the API you can create and update issues, manage comments, labels, and assignments, link branches and pull requests, and read reactions, modification history, and operation logs.

Repository-level labels and milestones have their own groups; this page covers only the endpoints of issues themselves.

Objects¶

Identification¶

• Repository-level endpoints identify the repository with owner + repo and the issue number with number.
• Comment-level endpoints identify a specific comment with id (or comment_id); paths look like /issues/comments/{id} and /issues/comment/{comment_id}/….
• Enterprise-level endpoints use enterprise to identify the enterprise namespace; paths start with /api/v5/enterprises/{enterprise}/.
• Organization-level endpoints use org to identify the organization; paths start with /api/v5/orgs/{org}/.

Common tasks¶

Notes¶

• The create and update issue paths include only {owner}, not {repo}: POST /api/v5/repos/{owner}/issues and PATCH /api/v5/repos/{owner}/issues/{number}, which differs from the /repos/{owner}/{repo}/… form used by other endpoints in this section.
• Reaction endpoints are split across two paths: reactions on an issue use /issues/{number}/user_reactions, and reactions on a comment use /issues/comment/{comment_id}/user_reactions; note the singular comment.
• When deleting labels, {name} accepts multiple label names separated by commas for bulk deletion.
• Enterprise-level issues and repository-level issues are two separate sets of endpoints (/enterprises/{enterprise}/issues/… and /repos/{owner}/{repo}/issues/…); the enterprise side also has a dedicated issue state endpoint /enterprises/{enterprise}/issue/statuses.
• Issue label and milestone management endpoints live in their own groups; this group only attaches and detaches them on issues.

Endpoint list¶

This module contains 28 endpoints.