GitHub v3 REST API

Issue Search Result Item

object

Issue Search Result Item

urlstring(uri)required
repository_urlstring(uri)required
labels_urlstringrequired
comments_urlstring(uri)required
events_urlstring(uri)required
html_urlstring(uri)required
idintegerrequired
node_idstringrequired
numberintegerrequired
titlestringrequired
lockedbooleanrequired
active_lock_reasonstring
assigneesarray[object]

Simple User

Show Child Parameters
userobjectrequired

Simple User

Show Child Parameters
labelsarray[object]required
Show Child Parameters
statestringrequired
assigneeobjectrequired

Simple User

Show Child Parameters
milestoneobjectrequired

A collection of related issues and pull requests.

Show Child Parameters
commentsintegerrequired
created_atstring(date-time)required
updated_atstring(date-time)required
closed_atstring(date-time)required
text_matchesarray[object]
Show Child Parameters
pull_requestobject
Show Child Parameters
bodystring
scorenumberrequired
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

draftboolean
repositoryobject

A git repository

Show Child Parameters
body_htmlstring
body_textstring
timeline_urlstring(uri)
performed_via_github_appobject

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Show Child Parameters
reactionsobject
Show Child Parameters
Example

Label Search Result Item

object

Label Search Result Item

idintegerrequired
node_idstringrequired
urlstring(uri)required
namestringrequired
colorstringrequired
defaultbooleanrequired
descriptionstringrequired
scorenumberrequired
text_matchesarray[object]
Show Child Parameters
Example

Repo Search Result Item

object

Repo Search Result Item

idintegerrequired
node_idstringrequired
namestringrequired
full_namestringrequired
ownerobjectrequired

Simple User

Show Child Parameters
privatebooleanrequired
html_urlstring(uri)required
descriptionstringrequired
forkbooleanrequired
urlstring(uri)required
created_atstring(date-time)required
updated_atstring(date-time)required
pushed_atstring(date-time)required
homepagestring(uri)required
sizeintegerrequired
stargazers_countintegerrequired
watchers_countintegerrequired
languagestringrequired
forks_countintegerrequired
open_issues_countintegerrequired
master_branchstring
default_branchstringrequired
scorenumberrequired
forks_urlstring(uri)required
keys_urlstringrequired
collaborators_urlstringrequired
teams_urlstring(uri)required
hooks_urlstring(uri)required
issue_events_urlstringrequired
events_urlstring(uri)required
assignees_urlstringrequired
branches_urlstringrequired
tags_urlstring(uri)required
blobs_urlstringrequired
git_tags_urlstringrequired
git_refs_urlstringrequired
trees_urlstringrequired
statuses_urlstringrequired
languages_urlstring(uri)required
stargazers_urlstring(uri)required
contributors_urlstring(uri)required
subscribers_urlstring(uri)required
subscription_urlstring(uri)required
commits_urlstringrequired
git_commits_urlstringrequired
comments_urlstringrequired
issue_comment_urlstringrequired
contents_urlstringrequired
compare_urlstringrequired
merges_urlstring(uri)required
archive_urlstringrequired
downloads_urlstring(uri)required
issues_urlstringrequired
pulls_urlstringrequired
milestones_urlstringrequired
notifications_urlstringrequired
labels_urlstringrequired
releases_urlstringrequired
deployments_urlstring(uri)required
git_urlstringrequired
ssh_urlstringrequired
clone_urlstringrequired
svn_urlstring(uri)required
forksintegerrequired
open_issuesintegerrequired
watchersintegerrequired
topicsarray[string]
mirror_urlstring(uri)required
has_issuesbooleanrequired
has_projectsbooleanrequired
has_pagesbooleanrequired
has_wikibooleanrequired
has_downloadsbooleanrequired
archivedbooleanrequired
disabledbooleanrequired

Returns whether or not this repository disabled.

visibilitystring

The repository visibility: public, private, or internal.

licenseobjectrequired

License Simple

Show Child Parameters
permissionsobject
Show Child Parameters
text_matchesarray[object]
Show Child Parameters
temp_clone_tokenstring
allow_merge_commitboolean
allow_squash_mergeboolean
allow_rebase_mergeboolean
delete_branch_on_mergeboolean
allow_forkingboolean
is_templateboolean
Example

Topic Search Result Item

object

Topic Search Result Item

namestringrequired
display_namestringrequired
short_descriptionstringrequired
descriptionstringrequired
created_bystringrequired
releasedstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
featuredbooleanrequired
curatedbooleanrequired
scorenumberrequired
repository_countinteger
logo_urlstring(uri)
text_matchesarray[object]
Show Child Parameters
relatedarray[object]
Show Child Parameters
aliasesarray[object]
Show Child Parameters
Example

User Search Result Item

object

User Search Result Item

loginstringrequired
idintegerrequired
node_idstringrequired
avatar_urlstring(uri)required
gravatar_idstringrequired
urlstring(uri)required
html_urlstring(uri)required
followers_urlstring(uri)required
subscriptions_urlstring(uri)required
organizations_urlstring(uri)required
repos_urlstring(uri)required
received_events_urlstring(uri)required
typestringrequired
scorenumberrequired
following_urlstringrequired
gists_urlstringrequired
starred_urlstringrequired
events_urlstringrequired
public_reposinteger
public_gistsinteger
followersinteger
followinginteger
created_atstring(date-time)
updated_atstring(date-time)
namestring
biostring
emailstring(email)
locationstring
site_adminbooleanrequired
hireableboolean
text_matchesarray[object]
Show Child Parameters
blogstring
companystring
suspended_atstring(date-time)
Example