Activity

Download Spec

Activity APIs provide access to notifications, subscriptions, and timelines.

List public events

get /events

We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

per_page

int

The number of results per page (max 100).

Default
30

page

int

Page number of the results to fetch.

Default
1

Response

Examples Schema

Response

[
  {
    "id": "22249084947",
    "type": "WatchEvent",
    "actor": {
      "id": 583231,
      "login": "octocat",
      "display_login": "octocat",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
    },
    "repo": {
      "id": 1296269,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "payload": {
      "action": "started"
    },
    "public": true,
    "created_at": "2022-06-09T12:47:28Z"
  },
  {
    "id": "22249084964",
    "type": "PushEvent",
    "actor": {
      "id": 583231,
      "login": "octocat",
      "display_login": "octocat",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
    },
    "repo": {
      "id": 1296269,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "payload": {
      "push_id": 10115855396,
      "size": 1,
      "distinct_size": 1,
      "ref": "refs/heads/master",
      "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
      "before": "883efe034920928c47fe18598c01249d1a9fdabd",
      "commits": [
        {
          "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
          "author": {
            "email": "octocat@github.com",
            "name": "Monalisa Octocat"
          },
          "message": "commit",
          "distinct": true,
          "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
        }
      ]
    },
    "public": true,
    "created_at": "2022-06-07T07:50:26Z"
  }
]

Not modified

Empty response

Forbidden

{
  "message": "string",
  "documentation_url": "string",
  "url": "string",
  "status": "string"
}

Service unavailable

{
  "code": "string",
  "message": "string",
  "documentation_url": "string"
}

array[object (Event)]

Event

object (Event)

Event

id

string

required

type

string or null

required

actor

object (actor)

required

Actor

id

int

required

login

string

required

display_login

string

gravatar_id

string or null

required

url

string

uri

required

avatar_url

string

uri

required

repo

object (repo)

required

id

int

required

name

string

required

url

string

uri

required

org

object (org)

Actor

id

int

required

login

string

required

display_login

string

gravatar_id

string or null

required

url

string

uri

required

avatar_url

string

uri

required

payload

object (payload)

required

action

string

issue

object (issue)

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

id

int

i64

required

node_id

string

required

url

string

uri

required

URL for the issue

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

repository_url

string

uri

required

labels_url

string

required

comments_url

string

uri

required

events_url

string

uri

required

html_url

string

uri

required

number

int

required

Number uniquely identifying the issue within its repository

Example
42

state

string

required

State of the issue; either 'open' or 'closed'

Example
"open"

state_reason

string or null

The reason for the current state

Enum
  • completed
  • reopened
  • not_planned
Example
"not_planned"

title

string

required

Title of the issue

Example
"Widget creation fails in Safari on OS X 10.8"

body

string or null

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?"

user

object (user) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

labels

array[One Of]

required

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" ]

One Of

string

object

id

int

i64

node_id

string

url

string

uri

name

string

description

string or null

color

string or null

default

boolean

assignee

object (assignee) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

assignees

array[object (Simple User)] or null

Simple User

object (Simple User)

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

milestone

object (milestone) or null

required

A collection of related issues and pull requests.

url

string

uri

required

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

html_url

string

uri

required

Example
"https://github.com/octocat/Hello-World/milestones/v1.0"

labels_url

string

uri

required

Example
"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels"

id

int

required

Example
1002604

node_id

string

required

Example
"MDk6TWlsZXN0b25lMTAwMjYwNA=="

number

int

required

The number of the milestone.

Example
42

state

string

required

The state of the milestone.

Default
"open"
Enum
  • open
  • closed
Example
"open"

title

string

required

The title of the milestone.

Example
"v1.0"

description

string or null

required

Example
"Tracking milestone for version 1.0"

creator

object (creator) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

open_issues

int

required

Example
4

closed_issues

int

required

Example
8

created_at

string

date-time

required

Example
"2011-04-10T20:09:31Z"

updated_at

string

date-time

required

Example
"2014-03-03T18:58:10Z"

closed_at

string or null

date-time

required

Example
"2013-02-12T13:22:01Z"

due_on

string or null

date-time

required

Example
"2012-10-09T23:39:01Z"

locked

boolean

required

active_lock_reason

string or null

comments

int

required

pull_request

object (pull_request)

merged_at

string or null

date-time

diff_url

string or null

uri

required

html_url

string or null

uri

required

patch_url

string or null

uri

required

url

string or null

uri

required

closed_at

string or null

date-time

required

created_at

string

date-time

required

updated_at

string

date-time

required

draft

boolean

closed_by

object (closed_by) or null

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

body_html

string

body_text

string

timeline_url

string

uri

repository

object (repository)

A repository on GitHub.

id

int

required

Unique identifier of the repository

Example
42

node_id

string

required

Example
"MDEwOlJlcG9zaXRvcnkxMjk2MjY5"

name

string

required

The name of the repository.

Example
"Team Environment"

full_name

string

required

Example
"octocat/Hello-World"

license

object (license) or null

required

License Simple

key

string

required

Example
"mit"

name

string

required

Example
"MIT License"

url

string or null

uri

required

Example
"https://api.github.com/licenses/mit"

spdx_id

string or null

required

Example
"MIT"

node_id

string

required

Example
"MDc6TGljZW5zZW1pdA=="

html_url

string

uri

organization

object (organization) or null

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

forks

int

required

permissions

object (permissions)

admin

boolean

required

pull

boolean

required

triage

boolean

push

boolean

required

maintain

boolean

owner

object (owner)

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

private

boolean

required

Whether the repository is private or public.

Default
false

html_url

string

uri

required

Example
"https://github.com/octocat/Hello-World"

description

string or null

required

Example
"This your first repo!"

fork

boolean

required

url

string

uri

required

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

archive_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"

assignees_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/assignees{/user}"

blobs_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"

branches_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/branches{/branch}"

collaborators_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"

comments_url

string

required

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

commits_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/commits{/sha}"

compare_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"

contents_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/contents/{+path}"

contributors_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/contributors"

deployments_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/deployments"

downloads_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/downloads"

events_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/events"

forks_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/forks"

git_commits_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"

git_refs_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"

git_tags_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"

git_url

string

required

Example
"git:github.com/octocat/Hello-World.git"

issue_comment_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"

issue_events_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"

issues_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/issues{/number}"

keys_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"

labels_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/labels{/name}"

languages_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/languages"

merges_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/merges"

milestones_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/milestones{/number}"

notifications_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"

pulls_url

string

required

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

releases_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/releases{/id}"

ssh_url

string

required

Example
"git@github.com:octocat/Hello-World.git"

stargazers_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/stargazers"

statuses_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"

subscribers_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/subscribers"

subscription_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/subscription"

tags_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/tags"

teams_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/teams"

trees_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"

clone_url

string

required

Example
"https://github.com/octocat/Hello-World.git"

mirror_url

string or null

uri

required

Example
"git:git.example.com/octocat/Hello-World"

hooks_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/hooks"

svn_url

string

uri

required

Example
"https://svn.github.com/octocat/Hello-World"

homepage

string or null

uri

required

Example
"https://github.com"

language

string or null

required

forks_count

int

required

Example
9

stargazers_count

int

required

Example
80

watchers_count

int

required

Example
80

size

int

required

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

Example
108

default_branch

string

required

The default branch of the repository.

Example
"master"

open_issues_count

int

required

Example
0

is_template

boolean

Whether this repository acts as a template that can be used to generate new repositories.

Default
false
Example
true

topics

array[string]

string

has_issues

boolean

required

Whether issues are enabled.

Default
true
Example
true

has_projects

boolean

required

Whether projects are enabled.

Default
true
Example
true

has_wiki

boolean

required

Whether the wiki is enabled.

Default
true
Example
true

has_pages

boolean

required

has_downloads

boolean

required

Whether downloads are enabled.

Default
true
Example
true

has_discussions

boolean

Whether discussions are enabled.

Default
false
Example
true

archived

boolean

required

Whether the repository is archived.

Default
false

disabled

boolean

required

Returns whether or not this repository disabled.

visibility

string

The repository visibility: public, private, or internal.

Default
"public"

pushed_at

string or null

date-time

required

Example
"2011-01-26T19:06:43Z"

created_at

string or null

date-time

required

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

updated_at

string or null

date-time

required

Example
"2011-01-26T19:14:43Z"

allow_rebase_merge

boolean

Whether to allow rebase merges for pull requests.

Default
true
Example
true

template_repository

object (template_repository) or null

id

int

node_id

string

name

string

full_name

string

owner

object (owner)

login

string

id

int

node_id

string

avatar_url

string

gravatar_id

string

url

string

html_url

string

followers_url

string

following_url

string

gists_url

string

starred_url

string

subscriptions_url

string

organizations_url

string

repos_url

string

events_url

string

received_events_url

string

type

string

site_admin

boolean

private

boolean

html_url

string

description

string

fork

boolean

url

string

archive_url

string

assignees_url

string

blobs_url

string

branches_url

string

collaborators_url

string

comments_url

string

commits_url

string

compare_url

string

contents_url

string

contributors_url

string

deployments_url

string

downloads_url

string

events_url

string

forks_url

string

git_commits_url

string

git_refs_url

string

git_tags_url

string

git_url

string

issue_comment_url

string

issue_events_url

string

issues_url

string

keys_url

string

labels_url

string

languages_url

string

merges_url

string

milestones_url

string

notifications_url

string

pulls_url

string

releases_url

string

ssh_url

string

stargazers_url

string

statuses_url

string

subscribers_url

string

subscription_url

string

tags_url

string

teams_url

string

trees_url

string

clone_url

string

mirror_url

string

hooks_url

string

svn_url

string

homepage

string

language

string

forks_count

int

stargazers_count

int

watchers_count

int

size

int

default_branch

string

open_issues_count

int

is_template

boolean

topics

array[string]

string

has_issues

boolean

has_projects

boolean

has_wiki

boolean

has_pages

boolean

has_downloads

boolean

archived

boolean

disabled

boolean

visibility

string

pushed_at

string

created_at

string

updated_at

string

permissions

object (permissions)

admin

boolean

maintain

boolean

push

boolean

triage

boolean

pull

boolean

allow_rebase_merge

boolean

temp_clone_token

string

allow_squash_merge

boolean

allow_auto_merge

boolean

delete_branch_on_merge

boolean

allow_update_branch

boolean

use_squash_pr_title_as_default

boolean

squash_merge_commit_title

string

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request's title.
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
Enum
  • PR_TITLE
  • COMMIT_OR_PR_TITLE

squash_merge_commit_message

string

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request's body.
  • COMMIT_MESSAGES - default to the branch's commit messages.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • COMMIT_MESSAGES
  • BLANK

merge_commit_title

string

The default value for a merge commit title.

  • PR_TITLE - default to the pull request's title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
Enum
  • PR_TITLE
  • MERGE_MESSAGE

merge_commit_message

string

The default value for a merge commit message.

  • PR_TITLE - default to the pull request's title.
  • PR_BODY - default to the pull request's body.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • PR_TITLE
  • BLANK

allow_merge_commit

boolean

subscribers_count

int

network_count

int

temp_clone_token

string

allow_squash_merge

boolean

Whether to allow squash merges for pull requests.

Default
true
Example
true

allow_auto_merge

boolean

Whether to allow Auto-merge to be used on pull requests.

Default
false
Example
false

delete_branch_on_merge

boolean

Whether to delete head branches when pull requests are merged

Default
false
Example
false

allow_update_branch

boolean

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

Default
false
Example
false

use_squash_pr_title_as_default

boolean

deprecated

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

Default
false

squash_merge_commit_title

string

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request's title.
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
Enum
  • PR_TITLE
  • COMMIT_OR_PR_TITLE

squash_merge_commit_message

string

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request's body.
  • COMMIT_MESSAGES - default to the branch's commit messages.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • COMMIT_MESSAGES
  • BLANK

merge_commit_title

string

The default value for a merge commit title.

  • PR_TITLE - default to the pull request's title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
Enum
  • PR_TITLE
  • MERGE_MESSAGE

merge_commit_message

string

The default value for a merge commit message.

  • PR_TITLE - default to the pull request's title.
  • PR_BODY - default to the pull request's body.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • PR_TITLE
  • BLANK

allow_merge_commit

boolean

Whether to allow merge commits for pull requests.

Default
true
Example
true

allow_forking

boolean

Whether to allow forking this repo

web_commit_signoff_required

boolean

Whether to require contributors to sign off on web-based commits

Default
false

subscribers_count

int

network_count

int

open_issues

int

required

watchers

int

required

master_branch

string

starred_at

string

Example
"\"2020-07-09T00:17:42Z\""

anonymous_access_enabled

boolean

Whether anonymous git access is enabled for this repository

performed_via_github_app

object (performed_via_github_app) or null

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.

id

int

required

Unique identifier of the GitHub app

Example
37

slug

string

The slug name of the GitHub app

Example
"probot-owners"

node_id

string

required

Example
"MDExOkludGVncmF0aW9uMQ=="

owner

object (owner) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

name

string

required

The name of the GitHub app

Example
"Probot Owners"

description

string or null

required

Example
"The description of the app."

external_url

string

uri

required

Example
"https://example.com"

html_url

string

uri

required

Example
"https://github.com/apps/super-ci"

created_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

updated_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

permissions

object (permissions)

required

The set of permissions for the GitHub app

Example
{ "issues": "read", "deployments": "write" }

issues

string

checks

string

metadata

string

contents

string

deployments

string

events

array[string]

required

The list of events for the GitHub app

Example
[ "label", "deployment" ]

string

installations_count

int

The number of installations associated with the GitHub app

Example
5

client_id

string

Example
"\"Iv1.25b5d1e65ffc4022\""

client_secret

string

Example
"\"1d4b2097ac622ba702d19de498f005747a8b21d3\""

webhook_secret

string or null

Example
"\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""

pem

string

Example
"\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""

author_association

string

required

How the author is associated with the repository.

Enum
  • COLLABORATOR
  • CONTRIBUTOR
  • FIRST_TIMER
  • FIRST_TIME_CONTRIBUTOR
  • MANNEQUIN
  • MEMBER
  • NONE
  • OWNER
Example
"OWNER"

reactions

object (reactions)

url

string

uri

required

total_count

int

required

+1

int

required

-1

int

required

laugh

int

required

confused

int

required

heart

int

required

hooray

int

required

eyes

int

required

rocket

int

required

comment

object (comment)

Comments provide a way for people to collaborate on an issue.

id

int

i64

required

Unique identifier of the issue comment

Example
42

node_id

string

required

url

string

uri

required

URL for the issue comment

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

body

string

Contents of the issue comment

Example
"What version of Safari were you using when you observed this bug?"

body_text

string

body_html

string

html_url

string

uri

required

user

object (user) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

created_at

string

date-time

required

Example
"2011-04-14T16:00:49Z"

updated_at

string

date-time

required

Example
"2011-04-14T16:00:49Z"

issue_url

string

uri

required

author_association

string

required

How the author is associated with the repository.

Enum
  • COLLABORATOR
  • CONTRIBUTOR
  • FIRST_TIMER
  • FIRST_TIME_CONTRIBUTOR
  • MANNEQUIN
  • MEMBER
  • NONE
  • OWNER
Example
"OWNER"

performed_via_github_app

object (performed_via_github_app) or null

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.

id

int

required

Unique identifier of the GitHub app

Example
37

slug

string

The slug name of the GitHub app

Example
"probot-owners"

node_id

string

required

Example
"MDExOkludGVncmF0aW9uMQ=="

owner

object (owner) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

name

string

required

The name of the GitHub app

Example
"Probot Owners"

description

string or null

required

Example
"The description of the app."

external_url

string

uri

required

Example
"https://example.com"

html_url

string

uri

required

Example
"https://github.com/apps/super-ci"

created_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

updated_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

permissions

object (permissions)

required

The set of permissions for the GitHub app

Example
{ "issues": "read", "deployments": "write" }

issues

string

checks

string

metadata

string

contents

string

deployments

string

events

array[string]

required

The list of events for the GitHub app

Example
[ "label", "deployment" ]

string

installations_count

int

The number of installations associated with the GitHub app

Example
5

client_id

string

Example
"\"Iv1.25b5d1e65ffc4022\""

client_secret

string

Example
"\"1d4b2097ac622ba702d19de498f005747a8b21d3\""

webhook_secret

string or null

Example
"\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""

pem

string

Example
"\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""

reactions

object (reactions)

url

string

uri

required

total_count

int

required

+1

int

required

-1

int

required

laugh

int

required

confused

int

required

heart

int

required

hooray

int

required

eyes

int

required

rocket

int

required

pages

array[object]

object

page_name

string

title

string

summary

string or null

action

string

sha

string

html_url

string

public

boolean

required

created_at

string or null

date-time

required

No schema

message

string

documentation_url

string

url

string

status

string

code

string

message

string

documentation_url

string

Get feeds

get /feeds

GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:

  • Timeline: The GitHub Enterprise Server global public timeline
  • User: The public timeline for any user, using URI template
  • Current user public: The public timeline for the authenticated user
  • Current user: The private timeline for the authenticated user
  • Current user actor: The private timeline for activity created by the authenticated user
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.

Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

Response

Examples Schema

Response

{
  "timeline_url": "https://github.com/timeline",
  "user_url": "https://github.com/{user}",
  "current_user_public_url": "https://github.com/octocat",
  "current_user_url": "https://github.com/octocat.private?token=abc123",
  "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123",
  "current_user_organization_url": "",
  "current_user_organization_urls": [
    "https://github.com/organizations/github/octocat.private.atom?token=abc123"
  ],
  "security_advisories_url": "https://github.com/security-advisories",
  "_links": {
    "timeline": {
      "href": "https://github.com/timeline",
      "type": "application/atom+xml"
    },
    "user": {
      "href": "https://github.com/{user}",
      "type": "application/atom+xml"
    },
    "current_user_public": {
      "href": "https://github.com/octocat",
      "type": "application/atom+xml"
    },
    "current_user": {
      "href": "https://github.com/octocat.private?token=abc123",
      "type": "application/atom+xml"
    },
    "current_user_actor": {
      "href": "https://github.com/octocat.private.actor?token=abc123",
      "type": "application/atom+xml"
    },
    "current_user_organization": {
      "href": "",
      "type": ""
    },
    "current_user_organizations": [
      {
        "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123",
        "type": "application/atom+xml"
      }
    ]
  }
}

timeline_url

string

required

Example
"https://github.com/timeline"

user_url

string

required

Example
"https://github.com/{user}"

current_user_public_url

string

Example
"https://github.com/octocat"

current_user_url

string

Example
"https://github.com/octocat.private?token=abc123"

current_user_actor_url

string

Example
"https://github.com/octocat.private.actor?token=abc123"

current_user_organization_url

string

Example
"https://github.com/octocat-org"

current_user_organization_urls

array[string]

Example
[ "https://github.com/organizations/github/octocat.private.atom?token=abc123" ]

string

uri

security_advisories_url

string

Example
"https://github.com/security-advisories"

repository_discussions_url

string

A feed of discussions for a given repository.

Example
"https://github.com/{user}/{repo}/discussions"

repository_discussions_category_url

string

A feed of discussions for a given repository and category.

Example
"https://github.com/{user}/{repo}/discussions/categories/{category}"

_links

object (_links)

required

timeline

object (timeline)

required

Hypermedia Link with Type

href

string

required

type

string

required

user

object (user)

required

Hypermedia Link with Type

href

string

required

type

string

required

security_advisories

object (security_advisories)

Hypermedia Link with Type

href

string

required

type

string

required

current_user

object (current_user)

Hypermedia Link with Type

href

string

required

type

string

required

current_user_public

object (current_user_public)

Hypermedia Link with Type

href

string

required

type

string

required

current_user_actor

object (current_user_actor)

Hypermedia Link with Type

href

string

required

type

string

required

current_user_organization

object (current_user_organization)

Hypermedia Link with Type

href

string

required

type

string

required

current_user_organizations

array[object (Link With Type)]

Link With Type

object (Link With Type)

Hypermedia Link with Type

href

string

required

type

string

required

repository_discussions

object (repository_discussions)

Hypermedia Link with Type

href

string

required

type

string

required

repository_discussions_category

object (repository_discussions_category)

Hypermedia Link with Type

href

string

required

type

string

required

List public events for a network of repositories

get /networks/{owner}/{repo}/events

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

per_page

int

The number of results per page (max 100).

Default
30

page

int

Page number of the results to fetch.

Default
1

Response

Examples Schema

Response

[
  {
    "id": "22249084964",
    "type": "PushEvent",
    "actor": {
      "id": 583231,
      "login": "octocat",
      "display_login": "octocat",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
    },
    "repo": {
      "id": 1296269,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "payload": {
      "push_id": 10115855396,
      "size": 1,
      "distinct_size": 1,
      "ref": "refs/heads/master",
      "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
      "before": "883efe034920928c47fe18598c01249d1a9fdabd",
      "commits": [
        {
          "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300",
          "author": {
            "email": "octocat@github.com",
            "name": "Monalisa Octocat"
          },
          "message": "commit",
          "distinct": true,
          "url": "https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300"
        }
      ]
    },
    "public": true,
    "created_at": "2022-06-09T12:47:28Z"
  },
  {
    "id": "22237752260",
    "type": "WatchEvent",
    "actor": {
      "id": 583231,
      "login": "octocat",
      "display_login": "octocat",
      "gravatar_id": "",
      "url": "https://api.github.com/users/rrubenich",
      "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4"
    },
    "repo": {
      "id": 1296269,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "payload": {
      "action": "started"
    },
    "public": true,
    "created_at": "2022-06-08T23:29:25Z"
  }
]

Resource not found

{
  "message": "string",
  "documentation_url": "string",
  "url": "string",
  "status": "string"
}

Forbidden

{
  "message": "string",
  "documentation_url": "string",
  "url": "string",
  "status": "string"
}

Not modified

Empty response

Moved permanently

{
  "message": "string",
  "documentation_url": "string",
  "url": "string",
  "status": "string"
}

array[object (Event)]

Event

object (Event)

Event

id

string

required

type

string or null

required

actor

object (actor)

required

Actor

id

int

required

login

string

required

display_login

string

gravatar_id

string or null

required

url

string

uri

required

avatar_url

string

uri

required

repo

object (repo)

required

id

int

required

name

string

required

url

string

uri

required

org

object (org)

Actor

id

int

required

login

string

required

display_login

string

gravatar_id

string or null

required

url

string

uri

required

avatar_url

string

uri

required

payload

object (payload)

required

action

string

issue

object (issue)

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

id

int

i64

required

node_id

string

required

url

string

uri

required

URL for the issue

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

repository_url

string

uri

required

labels_url

string

required

comments_url

string

uri

required

events_url

string

uri

required

html_url

string

uri

required

number

int

required

Number uniquely identifying the issue within its repository

Example
42

state

string

required

State of the issue; either 'open' or 'closed'

Example
"open"

state_reason

string or null

The reason for the current state

Enum
  • completed
  • reopened
  • not_planned
Example
"not_planned"

title

string

required

Title of the issue

Example
"Widget creation fails in Safari on OS X 10.8"

body

string or null

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?"

user

object (user) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

labels

array[One Of]

required

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" ]

One Of

string

object

id

int

i64

node_id

string

url

string

uri

name

string

description

string or null

color

string or null

default

boolean

assignee

object (assignee) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

assignees

array[object (Simple User)] or null

Simple User

object (Simple User)

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

milestone

object (milestone) or null

required

A collection of related issues and pull requests.

url

string

uri

required

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

html_url

string

uri

required

Example
"https://github.com/octocat/Hello-World/milestones/v1.0"

labels_url

string

uri

required

Example
"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels"

id

int

required

Example
1002604

node_id

string

required

Example
"MDk6TWlsZXN0b25lMTAwMjYwNA=="

number

int

required

The number of the milestone.

Example
42

state

string

required

The state of the milestone.

Default
"open"
Enum
  • open
  • closed
Example
"open"

title

string

required

The title of the milestone.

Example
"v1.0"

description

string or null

required

Example
"Tracking milestone for version 1.0"

creator

object (creator) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

open_issues

int

required

Example
4

closed_issues

int

required

Example
8

created_at

string

date-time

required

Example
"2011-04-10T20:09:31Z"

updated_at

string

date-time

required

Example
"2014-03-03T18:58:10Z"

closed_at

string or null

date-time

required

Example
"2013-02-12T13:22:01Z"

due_on

string or null

date-time

required

Example
"2012-10-09T23:39:01Z"

locked

boolean

required

active_lock_reason

string or null

comments

int

required

pull_request

object (pull_request)

merged_at

string or null

date-time

diff_url

string or null

uri

required

html_url

string or null

uri

required

patch_url

string or null

uri

required

url

string or null

uri

required

closed_at

string or null

date-time

required

created_at

string

date-time

required

updated_at

string

date-time

required

draft

boolean

closed_by

object (closed_by) or null

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

body_html

string

body_text

string

timeline_url

string

uri

repository

object (repository)

A repository on GitHub.

id

int

required

Unique identifier of the repository

Example
42

node_id

string

required

Example
"MDEwOlJlcG9zaXRvcnkxMjk2MjY5"

name

string

required

The name of the repository.

Example
"Team Environment"

full_name

string

required

Example
"octocat/Hello-World"

license

object (license) or null

required

License Simple

key

string

required

Example
"mit"

name

string

required

Example
"MIT License"

url

string or null

uri

required

Example
"https://api.github.com/licenses/mit"

spdx_id

string or null

required

Example
"MIT"

node_id

string

required

Example
"MDc6TGljZW5zZW1pdA=="

html_url

string

uri

organization

object (organization) or null

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

forks

int

required

permissions

object (permissions)

admin

boolean

required

pull

boolean

required

triage

boolean

push

boolean

required

maintain

boolean

owner

object (owner)

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

private

boolean

required

Whether the repository is private or public.

Default
false

html_url

string

uri

required

Example
"https://github.com/octocat/Hello-World"

description

string or null

required

Example
"This your first repo!"

fork

boolean

required

url

string

uri

required

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

archive_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"

assignees_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/assignees{/user}"

blobs_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"

branches_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/branches{/branch}"

collaborators_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"

comments_url

string

required

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

commits_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/commits{/sha}"

compare_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"

contents_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/contents/{+path}"

contributors_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/contributors"

deployments_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/deployments"

downloads_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/downloads"

events_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/events"

forks_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/forks"

git_commits_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"

git_refs_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"

git_tags_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"

git_url

string

required

Example
"git:github.com/octocat/Hello-World.git"

issue_comment_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"

issue_events_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"

issues_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/issues{/number}"

keys_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"

labels_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/labels{/name}"

languages_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/languages"

merges_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/merges"

milestones_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/milestones{/number}"

notifications_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"

pulls_url

string

required

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

releases_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/releases{/id}"

ssh_url

string

required

Example
"git@github.com:octocat/Hello-World.git"

stargazers_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/stargazers"

statuses_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"

subscribers_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/subscribers"

subscription_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/subscription"

tags_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/tags"

teams_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/teams"

trees_url

string

required

Example
"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"

clone_url

string

required

Example
"https://github.com/octocat/Hello-World.git"

mirror_url

string or null

uri

required

Example
"git:git.example.com/octocat/Hello-World"

hooks_url

string

uri

required

Example
"http://api.github.com/repos/octocat/Hello-World/hooks"

svn_url

string

uri

required

Example
"https://svn.github.com/octocat/Hello-World"

homepage

string or null

uri

required

Example
"https://github.com"

language

string or null

required

forks_count

int

required

Example
9

stargazers_count

int

required

Example
80

watchers_count

int

required

Example
80

size

int

required

The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.

Example
108

default_branch

string

required

The default branch of the repository.

Example
"master"

open_issues_count

int

required

Example
0

is_template

boolean

Whether this repository acts as a template that can be used to generate new repositories.

Default
false
Example
true

topics

array[string]

string

has_issues

boolean

required

Whether issues are enabled.

Default
true
Example
true

has_projects

boolean

required

Whether projects are enabled.

Default
true
Example
true

has_wiki

boolean

required

Whether the wiki is enabled.

Default
true
Example
true

has_pages

boolean

required

has_downloads

boolean

required

Whether downloads are enabled.

Default
true
Example
true

has_discussions

boolean

Whether discussions are enabled.

Default
false
Example
true

archived

boolean

required

Whether the repository is archived.

Default
false

disabled

boolean

required

Returns whether or not this repository disabled.

visibility

string

The repository visibility: public, private, or internal.

Default
"public"

pushed_at

string or null

date-time

required

Example
"2011-01-26T19:06:43Z"

created_at

string or null

date-time

required

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

updated_at

string or null

date-time

required

Example
"2011-01-26T19:14:43Z"

allow_rebase_merge

boolean

Whether to allow rebase merges for pull requests.

Default
true
Example
true

template_repository

object (template_repository) or null

id

int

node_id

string

name

string

full_name

string

owner

object (owner)

login

string

id

int

node_id

string

avatar_url

string

gravatar_id

string

url

string

html_url

string

followers_url

string

following_url

string

gists_url

string

starred_url

string

subscriptions_url

string

organizations_url

string

repos_url

string

events_url

string

received_events_url

string

type

string

site_admin

boolean

private

boolean

html_url

string

description

string

fork

boolean

url

string

archive_url

string

assignees_url

string

blobs_url

string

branches_url

string

collaborators_url

string

comments_url

string

commits_url

string

compare_url

string

contents_url

string

contributors_url

string

deployments_url

string

downloads_url

string

events_url

string

forks_url

string

git_commits_url

string

git_refs_url

string

git_tags_url

string

git_url

string

issue_comment_url

string

issue_events_url

string

issues_url

string

keys_url

string

labels_url

string

languages_url

string

merges_url

string

milestones_url

string

notifications_url

string

pulls_url

string

releases_url

string

ssh_url

string

stargazers_url

string

statuses_url

string

subscribers_url

string

subscription_url

string

tags_url

string

teams_url

string

trees_url

string

clone_url

string

mirror_url

string

hooks_url

string

svn_url

string

homepage

string

language

string

forks_count

int

stargazers_count

int

watchers_count

int

size

int

default_branch

string

open_issues_count

int

is_template

boolean

topics

array[string]

string

has_issues

boolean

has_projects

boolean

has_wiki

boolean

has_pages

boolean

has_downloads

boolean

archived

boolean

disabled

boolean

visibility

string

pushed_at

string

created_at

string

updated_at

string

permissions

object (permissions)

admin

boolean

maintain

boolean

push

boolean

triage

boolean

pull

boolean

allow_rebase_merge

boolean

temp_clone_token

string

allow_squash_merge

boolean

allow_auto_merge

boolean

delete_branch_on_merge

boolean

allow_update_branch

boolean

use_squash_pr_title_as_default

boolean

squash_merge_commit_title

string

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request's title.
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
Enum
  • PR_TITLE
  • COMMIT_OR_PR_TITLE

squash_merge_commit_message

string

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request's body.
  • COMMIT_MESSAGES - default to the branch's commit messages.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • COMMIT_MESSAGES
  • BLANK

merge_commit_title

string

The default value for a merge commit title.

  • PR_TITLE - default to the pull request's title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
Enum
  • PR_TITLE
  • MERGE_MESSAGE

merge_commit_message

string

The default value for a merge commit message.

  • PR_TITLE - default to the pull request's title.
  • PR_BODY - default to the pull request's body.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • PR_TITLE
  • BLANK

allow_merge_commit

boolean

subscribers_count

int

network_count

int

temp_clone_token

string

allow_squash_merge

boolean

Whether to allow squash merges for pull requests.

Default
true
Example
true

allow_auto_merge

boolean

Whether to allow Auto-merge to be used on pull requests.

Default
false
Example
false

delete_branch_on_merge

boolean

Whether to delete head branches when pull requests are merged

Default
false
Example
false

allow_update_branch

boolean

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

Default
false
Example
false

use_squash_pr_title_as_default

boolean

deprecated

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

Default
false

squash_merge_commit_title

string

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request's title.
  • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
Enum
  • PR_TITLE
  • COMMIT_OR_PR_TITLE

squash_merge_commit_message

string

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request's body.
  • COMMIT_MESSAGES - default to the branch's commit messages.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • COMMIT_MESSAGES
  • BLANK

merge_commit_title

string

The default value for a merge commit title.

  • PR_TITLE - default to the pull request's title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
Enum
  • PR_TITLE
  • MERGE_MESSAGE

merge_commit_message

string

The default value for a merge commit message.

  • PR_TITLE - default to the pull request's title.
  • PR_BODY - default to the pull request's body.
  • BLANK - default to a blank commit message.
Enum
  • PR_BODY
  • PR_TITLE
  • BLANK

allow_merge_commit

boolean

Whether to allow merge commits for pull requests.

Default
true
Example
true

allow_forking

boolean

Whether to allow forking this repo

web_commit_signoff_required

boolean

Whether to require contributors to sign off on web-based commits

Default
false

subscribers_count

int

network_count

int

open_issues

int

required

watchers

int

required

master_branch

string

starred_at

string

Example
"\"2020-07-09T00:17:42Z\""

anonymous_access_enabled

boolean

Whether anonymous git access is enabled for this repository

performed_via_github_app

object (performed_via_github_app) or null

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.

id

int

required

Unique identifier of the GitHub app

Example
37

slug

string

The slug name of the GitHub app

Example
"probot-owners"

node_id

string

required

Example
"MDExOkludGVncmF0aW9uMQ=="

owner

object (owner) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

name

string

required

The name of the GitHub app

Example
"Probot Owners"

description

string or null

required

Example
"The description of the app."

external_url

string

uri

required

Example
"https://example.com"

html_url

string

uri

required

Example
"https://github.com/apps/super-ci"

created_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

updated_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

permissions

object (permissions)

required

The set of permissions for the GitHub app

Example
{ "issues": "read", "deployments": "write" }

issues

string

checks

string

metadata

string

contents

string

deployments

string

events

array[string]

required

The list of events for the GitHub app

Example
[ "label", "deployment" ]

string

installations_count

int

The number of installations associated with the GitHub app

Example
5

client_id

string

Example
"\"Iv1.25b5d1e65ffc4022\""

client_secret

string

Example
"\"1d4b2097ac622ba702d19de498f005747a8b21d3\""

webhook_secret

string or null

Example
"\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""

pem

string

Example
"\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""

author_association

string

required

How the author is associated with the repository.

Enum
  • COLLABORATOR
  • CONTRIBUTOR
  • FIRST_TIMER
  • FIRST_TIME_CONTRIBUTOR
  • MANNEQUIN
  • MEMBER
  • NONE
  • OWNER
Example
"OWNER"

reactions

object (reactions)

url

string

uri

required

total_count

int

required

+1

int

required

-1

int

required

laugh

int

required

confused

int

required

heart

int

required

hooray

int

required

eyes

int

required

rocket

int

required

comment

object (comment)

Comments provide a way for people to collaborate on an issue.

id

int

i64

required

Unique identifier of the issue comment

Example
42

node_id

string

required

url

string

uri

required

URL for the issue comment

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

body

string

Contents of the issue comment

Example
"What version of Safari were you using when you observed this bug?"

body_text

string

body_html

string

html_url

string

uri

required

user

object (user) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

created_at

string

date-time

required

Example
"2011-04-14T16:00:49Z"

updated_at

string

date-time

required

Example
"2011-04-14T16:00:49Z"

issue_url

string

uri

required

author_association

string

required

How the author is associated with the repository.

Enum
  • COLLABORATOR
  • CONTRIBUTOR
  • FIRST_TIMER
  • FIRST_TIME_CONTRIBUTOR
  • MANNEQUIN
  • MEMBER
  • NONE
  • OWNER
Example
"OWNER"

performed_via_github_app

object (performed_via_github_app) or null

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.

id

int

required

Unique identifier of the GitHub app

Example
37

slug

string

The slug name of the GitHub app

Example
"probot-owners"

node_id

string

required

Example
"MDExOkludGVncmF0aW9uMQ=="

owner

object (owner) or null

required

A GitHub user.

name

string or null

email

string or null

login

string

required

Example
"octocat"

id

int

required

Example
1

node_id

string

required

Example
"MDQ6VXNlcjE="

avatar_url

string

uri

required

Example
"https://github.com/images/error/octocat_happy.gif"

gravatar_id

string or null

required

Example
"41d064eb2195891e12d0413f63227ea7"

url

string

uri

required

Example
"https://api.github.com/users/octocat"

html_url

string

uri

required

Example
"https://github.com/octocat"

followers_url

string

uri

required

Example
"https://api.github.com/users/octocat/followers"

following_url

string

required

Example
"https://api.github.com/users/octocat/following{/other_user}"

gists_url

string

required

Example
"https://api.github.com/users/octocat/gists{/gist_id}"

starred_url

string

required

Example
"https://api.github.com/users/octocat/starred{/owner}{/repo}"

subscriptions_url

string

uri

required

Example
"https://api.github.com/users/octocat/subscriptions"

organizations_url

string

uri

required

Example
"https://api.github.com/users/octocat/orgs"

repos_url

string

uri

required

Example
"https://api.github.com/users/octocat/repos"

events_url

string

required

Example
"https://api.github.com/users/octocat/events{/privacy}"

received_events_url

string

uri

required

Example
"https://api.github.com/users/octocat/received_events"

type

string

required

Example
"User"

site_admin

boolean

required

starred_at

string

Example
"\"2020-07-09T00:17:55Z\""

name

string

required

The name of the GitHub app

Example
"Probot Owners"

description

string or null

required

Example
"The description of the app."

external_url

string

uri

required

Example
"https://example.com"

html_url

string

uri

required

Example
"https://github.com/apps/super-ci"

created_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

updated_at

string

date-time

required

Example
"2017-07-08T16:18:44-04:00"

permissions

object (permissions)

required

The set of permissions for the GitHub app

Example
{ "issues": "read", "deployments": "write" }

issues

string

checks

string

metadata

string

contents

string

deployments

string

events

array[string]

required

The list of events for the GitHub app

Example
[ "label", "deployment" ]

string

installations_count

int

The number of installations associated with the GitHub app

Example
5

client_id

string

Example
"\"Iv1.25b5d1e65ffc4022\""

client_secret

string

Example
"\"1d4b2097ac622ba702d19de498f005747a8b21d3\""

webhook_secret

string or null

Example
"\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""

pem

string

Example
"\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""

reactions

object (reactions)

url

string

uri

required

total_count

int

required

+1

int

required

-1

int

required

laugh

int

required

confused

int

required

heart

int

required

hooray

int

required

eyes

int

required

rocket

int

required

pages

array[object]

object

page_name

string

title

string

summary

string or null

action

string

sha

string

html_url

string

public

boolean

required

created_at

string or null

date-time

required

message

string

documentation_url

string

url

string

status

string

message

string

documentation_url

string

url

string

status

string

No schema

message

string

documentation_url

string

url

string

status

string

List notifications for the authenticated user

get /notifications

List all notifications for the current user, sorted by most recently updated.

all

boolean

If true, show notifications marked as read.

Default
false

participating

boolean

If true, only shows notifications in which the user is directly participating or mentioned.

Default
false

since

string

date-time

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

before

string

date-time

Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

page

int

Page number of the results to fetch.

Default
1

per_page

int

The number of results per page (max 50).

Default
50

Response

Examples Schema

Response

[
  {
    "id": "1",
    "repository": {
      "id": 1296269,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
      "name": "Hello-World",
      "full_name": "octocat/Hello-World",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "private": false,
      "html_url": "https://github.com/octocat/Hello-World",
      "description": "This your first repo!",
      "fork": false,
      "url": "https://api.github.com/repos/octocat/Hello-World",
      "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
      "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
      "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
      "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
      "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
      "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
      "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
      "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
      "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
      "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
      "git_url":