GitHub v3 REST API

Branch Short

object

Branch Short

namestringrequired
commitobjectrequired
Show Child Parameters
protectedbooleanrequired
Example

Link

object

Hypermedia Link

hrefstringrequired
Example

Pull Request Simple

object

Pull Request Simple

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1347

idintegerrequired

Example:1

node_idstringrequired

Example:MDExOlB1bGxSZXF1ZXN0MQ==

html_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/pull/1347

diff_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/pull/1347.diff

patch_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/pull/1347.patch

issue_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/issues/1347

commits_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits

review_comments_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments

review_comment_urlstringrequired

Example:https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}

comments_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/issues/1347/comments

statuses_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e

numberintegerrequired

Example:1347

statestringrequired

Example:open

lockedbooleanrequired

Example:true

titlestringrequired

Example:new-feature

userobjectrequired

Simple User

Show Child Parameters
bodystringrequired

Example:Please pull these awesome changes

labelsarray[object]required
Show Child Parameters
milestoneobjectrequired

A collection of related issues and pull requests.

Show Child Parameters
active_lock_reasonstring

Example:too heated

created_atstring(date-time)required

Example:2011-01-26T19:01:12Z

updated_atstring(date-time)required

Example:2011-01-26T19:01:12Z

closed_atstring(date-time)required

Example:2011-01-26T19:01:12Z

merged_atstring(date-time)required

Example:2011-01-26T19:01:12Z

merge_commit_shastringrequired

Example:e5bd3914e2e596debea16f433f57875b5b90bcd6

assigneeobjectrequired

Simple User

Show Child Parameters
assigneesarray[object]

Simple User

Show Child Parameters
requested_reviewersarray[object]

Simple User

Show Child Parameters
requested_teamsarray[object]

Groups of organization members that gives permissions on specified repositories.

Show Child Parameters
headobjectrequired
Show Child Parameters
baseobjectrequired
Show Child Parameters
_linksobjectrequired
Show Child Parameters
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

draftboolean

Indicates whether or not the pull request is a draft.

Example

Simple Commit Status

object
descriptionstringrequired
idintegerrequired
node_idstringrequired
statestringrequired
contextstringrequired
target_urlstring(uri)required
requiredboolean
avatar_urlstring(uri)required
urlstring(uri)required
created_atstring(date-time)required
updated_atstring(date-time)required
Example

Combined Commit Status

object

Combined Commit Status

statestringrequired
statusesarray[object]required
Show Child Parameters
shastringrequired
total_countintegerrequired
repositoryobjectrequired

Minimal Repository

Show Child Parameters
commit_urlstring(uri)required
urlstring(uri)required
Example