GitHub v3 REST API

Page Build

object

Page Build

urlstring(uri)required
statusstringrequired
errorobjectrequired
Show Child Parameters
pusherobjectrequired

Simple User

Show Child Parameters
commitstringrequired
durationintegerrequired
created_atstring(date-time)required
updated_atstring(date-time)required
Example

Page Build Status

object

Page Build Status

urlstring(uri)required

Example:https://api.github.com/repos/github/hello-world/pages/builds/latest

statusstringrequired

Example:queued

Example

repository-pre-receive-hook

object
idinteger
namestring
enforcementstring
configuration_urlstring
Example

Team Simple

object

Groups of organization members that gives permissions on specified repositories.

idintegerrequired

Unique identifier of the team

Example:1

node_idstringrequired

Example:MDQ6VGVhbTE=

urlstring(uri)required

URL for the team

Example:https://api.github.com/organizations/1/team/1

members_urlstringrequired

Example:https://api.github.com/organizations/1/team/1/members{/member}

namestringrequired

Name of the team

Example:Justice League

descriptionstringrequired

Description of the team

Example:A great team.

permissionstringrequired

Permission that the team will have for its repositories

Example:admin

privacystring

The level of privacy this team should have

Example:closed

html_urlstring(uri)required

Example:https://github.com/orgs/rails/teams/core

repositories_urlstring(uri)required

Example:https://api.github.com/organizations/1/team/1/repos

slugstringrequired

Example:justice-league

ldap_dnstring

Distinguished Name (DN) that team maps to within LDAP environment

Example:uid=example,ou=users,dc=github,dc=com

Example

Pull Request

object

Pull requests let you tell others about changes you’ve pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

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

Number uniquely identifying the pull request within its repository.

Example:42

statestringrequired

State of this Pull Request. Either open or closed.

Allowed values:openclosed

Example:open

lockedbooleanrequired

Example:true

titlestringrequired

The title of the pull request.

Example:Amazing 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.

mergedbooleanrequired
mergeablebooleanrequired

Example:true

rebaseableboolean

Example:true

mergeable_statestringrequired

Example:clean

merged_byobjectrequired

Simple User

Show Child Parameters
commentsintegerrequired

Example:10

review_commentsintegerrequired
maintainer_can_modifybooleanrequired

Indicates whether maintainers can modify the pull request.

Example:true

commitsintegerrequired

Example:3

additionsintegerrequired

Example:100

deletionsintegerrequired

Example:3

changed_filesintegerrequired

Example:5

Example