Endpoints
4 endpoints return issues on GitHub.
Schema
Single-item endpoints return this object as data; list endpoints return an array of them as data with a page object. The standard meta comes with every response.
platformstringPlatform ID (github, …).
idstringThe item's full reference on its host (owner/repo#123; group/project!34 for a GitLab merge request), as the host writes it to link it from anywhere; the issue endpoint takes it as input. It follows the repository's current name.
urlstring uriThe item's page (an issue's or a pull request's).
repositoryobjectThe repository it belongs to (id null when the answer names it by path alone).
ShowHide 3 child fields
idstringnullablePlatform-native repository ID, as Repository.id; null when the platform names the repository without it.
full_namestringOwner and name as in its link (torvalds/linux).
urlstring uriCanonical repository page URL.
numberintegerThe item's number in its repository (the 123 of #123).
is_pull_requestbooleantrue for a pull request (a merge request on GitLab), false for an issue (a discussion on Hugging Face).
titlestringThe item's title.
textstringnullableThe description as its author wrote it (Markdown source); null when it has none.
statestringopen; closed (closed without merging, or an issue closed); merged (a pull request merged into its base). New values may be added; treat unknown values as closed.
One ofopenclosedmerged
state_reasonstringnullableWhy a closed item was closed: completed (done or fixed), not_planned (won't do, stale, invalid), duplicate (replaced by another item). Null on an open or merged item and where the host does not say. New values may be added; treat unknown values as null.
One ofcompletednot_plannedduplicate
labelsstring[]Label names, in the host's order; [] when it has none (listed in unknown_fields when the source cannot see them).
authorobjectWho opened it.
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
assigneesobject[]Accounts it is assigned to; [] when none (listed in unknown_fields when the source cannot see them).
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
milestoneobjectnullableThe milestone it is planned for; null when none or not shown.
ShowHide 4 child fields
titlestringThe milestone's title.
urlstring urinullableThe milestone's page; null when not shown.
due_atstring date-timenullableWhen the milestone is due, RFC 3339 UTC (a due date alone at 00:00:00Z, listed in approximate_fields); null when it has none.
is_openbooleannullableThe milestone is still open (false once closed); null when not shown.
is_draftbooleannullableA pull request marked as a draft (not ready for review); null on an issue or when not shown.
is_lockedbooleannullableThe conversation is locked: only collaborators can comment. Null when not shown.
published_atstring date-timenullableWhen it was opened, RFC 3339 UTC; null when not shown.
updated_atstring date-timenullableWhen anything on it last changed (a comment, a label, an edit), RFC 3339 UTC; null when not shown.
closed_atstring date-timenullableWhen it was last closed or merged, RFC 3339 UTC; null while open, and when the host does not say.
closed_byobjectnullableWho last closed it (on a merged pull request, who merged it); null while open or when not shown (lists do not show it).
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
merged_atstring date-timenullableWhen the pull request was merged, RFC 3339 UTC; null on an issue and on a pull request not merged.
merged_byobjectnullableWho merged the pull request; null on an issue, on a pull request not merged, and when not shown (lists do not show it).
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
base_branchstringnullableThe branch the pull request merges into (main); null on an issue or when not shown.
head_branchstringnullableThe branch the pull request's changes come from; null on an issue, when not shown, and when the branch is gone.
head_repositoryobjectnullableThe repository head_branch is in: the item's repository itself, or a fork; null on an issue, when not shown, and when the fork is deleted.
ShowHide 3 child fields
idstringnullablePlatform-native repository ID, as Repository.id; null when the platform names the repository without it.
full_namestringOwner and name as in its link (torvalds/linux).
urlstring uriCanonical repository page URL.
metricsobjectCounts at fetch time; null = not shown, 0 = zero.
ShowHide 6 child fields
comment_countintegernullableComments in its conversation (not counting comments on lines of a pull request's code).
reaction_countintegernullableEmoji reactions to its description, all kinds together; null when not shown.
like_countintegernullableThumbs-up reactions (upvotes on GitLab), the ones counted in reaction_count; null when not shown.
changed_file_countintegernullableFiles the pull request changes; null on an issue and when not shown (lists do not show it).
added_line_countintegernullableLines the pull request adds; null on an issue and when not shown (lists do not show it).
deleted_line_countintegernullableLines the pull request deletes; null on an issue and when not shown (lists do not show it).
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
githubobjectnullableA GitHub issue's or pull request's own fields.
ShowHide 10 child fields
node_idstringnullableGitHub's GraphQL node ID (I_kwDO…, PR_kwDO…): the same after the repository is renamed or transferred, unlike id.
author_associationstringnullableThe author's relation to the repository: owner, member (of its organization), collaborator, contributor (has a merged commit), first_time_contributor, first_timer (first contribution on GitHub), mannequin (an imported placeholder) or none. New values may be added.
One ofownermembercollaboratorcontributorfirst_time_contributorfirst_timermannequinnone
issue_typestringnullableThe issue type its organization assigned (Bug, Feature, Task); null when none, and on a pull request.
lock_reasonstringnullableWhy the conversation was locked; null when it is not locked or no reason was given. New values may be added.
One ofresolvedoff_topictoo_heatedspam
reactionsobjectReactions to the description by emoji; each null when not shown.
ShowHide 8 child fields
thumbs_up_countintegernullable👍 (+1) reactions; metrics.like_count.
thumbs_down_countintegernullable👎 (-1) reactions.
laugh_countintegernullable😄 reactions.
hooray_countintegernullable🎉 reactions.
confused_countintegernullable😕 reactions.
heart_countintegernullable❤️ reactions.
rocket_countintegernullable🚀 reactions.
eyes_countintegernullable👀 reactions.
sub_issue_countintegernullableSub-issues it has; null when not shown and on a pull request.
completed_sub_issue_countintegernullableOf sub_issue_count, those closed as completed; null when not shown and on a pull request.
parent_issue_idstringnullableOn a sub-issue, the id of the issue it belongs to (owner/repo#123), which the issue endpoint takes as input; null when it has none, and on a pull request.
review_comment_countintegernullableReview comments on lines of the pull request's code; null on an issue and when not shown (lists do not show it).
commit_countintegernullableCommits in the pull request; null on an issue and when not shown (lists do not show it).
approximate_fieldsstring[]JSON paths of values rounded by the platform or parsed from display text. [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.
Item errors
Besides the request-level errors every endpoint can return, issue endpoints return:
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
not_found | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |