GitHub v3 REST API

Search Result Text Matches

array
object_urlstring
object_typestring
propertystring
fragmentstring
matchesarray[object]
Show Child Parameters

Code Search Result Item

object

Code Search Result Item

namestringrequired
pathstringrequired
shastringrequired
urlstring(uri)required
git_urlstring(uri)required
html_urlstring(uri)required
repositoryobjectrequired

Minimal Repository

Show Child Parameters
scorenumberrequired
file_sizeinteger
languagestring
last_modified_atstring(date-time)
line_numbersarray[string]

Example:73..77, 77..78

text_matchesarray[object]
Show Child Parameters
Example

Commit Search Result Item

object

Commit Search Result Item

urlstring(uri)required
shastringrequired
html_urlstring(uri)required
comments_urlstring(uri)required
commitobjectrequired
Show Child Parameters
authorobjectrequired

Simple User

Show Child Parameters
committerobjectrequired

Metaproperties for Git author/committer information.

Show Child Parameters
parentsarray[object]required
Show Child Parameters
repositoryobjectrequired

Minimal Repository

Show Child Parameters
scorenumberrequired
node_idstringrequired
text_matchesarray[object]
Show Child Parameters
Example

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