GitHub v3 REST API

Git Tree

object

The hierarchy between files in a Git repository.

shastringrequired
urlstring(uri)required
truncatedbooleanrequired
treearray[object]required

Objects specifying a tree structure

Example:{"path":"file.rb","mode":"100644","type":"blob","size":30,"sha":"44b4fc6d56897b048c772eb4087f854f46256132","url":"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132","properties":{"path":{"type":"string"},"mode":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"sha":{"type":"string"},"url":{"type":"string"}},"required":["path","mode","type","sha","url","size"]}

Show Child Parameters
Example

Hook Response

object
codeintegerrequired
statusstringrequired
messagestringrequired
Example

Webhook

object

Webhooks for repositories.

typestringrequired
idintegerrequired

Unique identifier of the webhook.

Example:42

namestringrequired

The name of a valid service, use ‘web’ for a webhook.

Example:web

activebooleanrequired

Determines whether the hook is actually triggered on pushes.

Example:true

eventsarray[string]required

Determines what events the hook is triggered for. Default: [‘push’].

Example:push, pull_request

configobjectrequired
Show Child Parameters
updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1

test_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1/test

ping_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1/pings

last_responseobjectrequired
Show Child Parameters
Example

Issue

object

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.

idintegerrequired
node_idstringrequired
urlstring(uri)required

URL for the issue

Example:https://api.github.com/repositories/42/issues/1

repository_urlstring(uri)required
labels_urlstringrequired
comments_urlstring(uri)required
events_urlstring(uri)required
html_urlstring(uri)required
numberintegerrequired

Number uniquely identifying the issue within its repository

Example:42

statestringrequired

State of the issue; either ‘open’ or ‘closed’

Example:open

titlestringrequired

Title of the issue

Example:Widget creation fails in Safari on OS X 10.8

bodystring

Contents of the issue

Example:It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?

userobjectrequired

Simple User

Show Child Parameters
labelsOne Of
arrayrequired

Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository

Example:bug, registration

Variant 1string
assigneeobjectrequired

Simple User

Show Child Parameters
assigneesarray[object]

Simple User

Show Child Parameters
milestoneobjectrequired

A collection of related issues and pull requests.

Show Child Parameters
lockedbooleanrequired
active_lock_reasonstring
commentsintegerrequired
pull_requestobject
Show Child Parameters
closed_atstring(date-time)required
created_atstring(date-time)required
updated_atstring(date-time)required
draftboolean
closed_byobject

Simple User

Show Child Parameters
body_htmlstring
body_textstring
timeline_urlstring(uri)
repositoryobject

A git repository

Show Child Parameters
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
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

reactionsobject
Show Child Parameters
Example

Issue Event Label

object

Issue Event Label

namestringrequired
colorstringrequired
Example