Skip to main content
The REST API is now versioned. For more information, see "About API versioning."

REST API endpoints for issue dependencies

Use the REST API to view, add, and remove issue dependencies.

List dependencies an issue is blocked by

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

This endpoint supports the following custom media types. For more information, see Media types.

  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

Fine-grained access tokens for "List dependencies an issue is blocked by"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Issues" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "List dependencies an issue is blocked by"

Headers
Name, Type, Description
accept string

Setting to application/vnd.github+json is recommended.

Path parameters
Name, Type, Description
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

issue_number integer Required

The number that identifies the issue.

Query parameters
Name, Type, Description
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default: 1

HTTP response status codes for "List dependencies an issue is blocked by"

Status codeDescription
200

OK

301

Moved permanently

404

Resource not found

410

Gone

Code samples for "List dependencies an issue is blocked by"

Request example

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