Activity - GitHub Docs

GitHub Docs
Article version: GitHub.com

# Activity

### In this article

- Events
- List public events
- List public events for a network of repositories
- List public organization events
- List repository events
- List events for the authenticated user
- List organization events for the authenticated user
- List public events for a user
- List events received by the authenticated user
- List public events received by a user
- Feeds
- Get feeds
- Example of getting an Atom feed
- Notifications
- Notification reasons
- List notifications for the authenticated user
- Mark notifications as read
- Get a thread
- Mark a thread as read
- Get a thread subscription for the authenticated user
- Set a thread subscription
- Delete a thread subscription
- List repository notifications for the authenticated user
- Mark repository notifications as read
- Starring
- Starring vs. Watching
- Custom media types for starring
- List stargazers
- List repositories starred by the authenticated user
- Check if a repository is starred by the authenticated user
- Star a repository for the authenticated user
- Unstar a repository for the authenticated user
- List repositories starred by a user
- Watching
- List watchers
- Get a repository subscription
- Set a repository subscription
- Delete a repository subscription
- List repositories watched by the authenticated user
- List repositories watched by a user

#### Did this doc help you?

Want to learn about new docs features and updates? Sign up for updates!

We're continually improving our docs. We'd love to hear how we can do better.

What problem did you have? Required

Let us know what we can do better Optional

Can we contact you if we have more questions? Optional

Thank you! Your feedback has been submitted.

## Events

The Events API is a read-only API to the GitHub events. These events power the various activity streams on the site.

The Events API can return different types of events triggered by activity on GitHub. For more information about the specific events that you can receive from the Events API, see "GitHub Event types." An events API for repository issues is also available. For more information, see the "Issue Events API."

Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.

    $ curl -I https://api.github.com/users/tater/events
    > HTTP/1.1 200 OK
    > X-Poll-Interval: 60
    > ETag: "a18c3bded88eb5dbb5c849a489412bf3"

    # The quotes around the ETag value are important
    $ curl -I https://api.github.com/users/tater/events \
    $    -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"'
    > HTTP/1.1 304 Not Modified
    > X-Poll-Interval: 60

Events support pagination, however the `per_page` option is unsupported. The fixed page size is 30 items. Fetching up to ten pages is supported, for a total of 300 events. For information, see "Traversing with pagination."

Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).

### List public 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.

    get /events

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/events

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /events')

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

### List public events for a network of repositories

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

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/networks/octocat/hello-world/events

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /networks/{owner}/{repo}/events', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

### List public organization events

    get /orgs/{org}/events

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`org` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/orgs/ORG/events

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /orgs/{org}/events', {
      org: 'org'
    })

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

### List repository events

    get /repos/{owner}/{repo}/events

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/events

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /repos/{owner}/{repo}/events', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

### List events for the authenticated user

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.

    get /users/{username}/events

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`username` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/users/USERNAME/events

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /users/{username}/events', {
      username: 'username'
    })

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

### List organization events for the authenticated user

This is the user's organization dashboard. You must be authenticated as the user to view this.

    get /users/{username}/events/orgs/{org}

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`username` | string | path |
`org` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/users/USERNAME/events/orgs/ORG

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /users/{username}/events/orgs/{org}', {
      username: 'username',
      org: 'org'
    })

#### Response

    Status: 200 OK

### List public events for a user

    get /users/{username}/events/public

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`username` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/users/USERNAME/events/public

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /users/{username}/events/public', {
      username: 'username'
    })

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

### List events received by the authenticated user

These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.

    get /users/{username}/received_events

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`username` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/users/USERNAME/received_events

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /users/{username}/received_events', {
      username: 'username'
    })

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

### List public events received by a user

    get /users/{username}/received_events/public

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`username` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/users/USERNAME/received_events/public

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /users/{username}/received_events/public', {
      username: 'username'
    })

#### Response

    Status: 200 OK

#### Notes

- Works with GitHub Apps

## Feeds

### Get feeds

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

- Timeline: The GitHub 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.

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

    get /feeds

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/feeds

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /feeds')

#### Default response

    Status: 200 OK

    {
      "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"
          }
        ],
        "security_advisories": {
          "href": "https://github.com/security-advisories",
          "type": "application/atom+xml"
        }
      }
    }

#### Notes

- Works with GitHub Apps

### Example of getting an Atom feed

To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories:

    curl -H "Accept: application/atom+xml" https://github.com/security-advisories

#### Response

    Status: 200 OK

    <?xml version="1.0" encoding="UTF-8"?>
    <feed xmlns="http://www.w3.org/2005/Atom" xmlns:media="http://search.yahoo.com/mrss/" xml:lang="en-US">
      <id>tag:github.com,2008:/security-advisories</id>
      <link rel="self" type="application/atom+xml" href="https://github.com/security-advisories.atom"/>
      <title>GitHub Security Advisory Feed</title>
      <author>
        <name>GitHub</name>
      </author>
      <updated>2019-01-14T19:34:52Z</updated>
         <entry>
          <id>tag:github.com,2008:GHSA-abcd-12ab-23cd</id>
          <published>2018-07-26T15:14:52Z</published>
          <updated>2019-01-14T19:34:52Z</updated>
          <title type="html">[GHSA-abcd-12ab-23cd] Moderate severity vulnerability that affects Octoapp</title>
            <category term="NPM"/>
          <content type="html">
            &lt;p&gt;Octoapp node module before 4.17.5 suffers from a Modification of Assumed-Immutable Data (MAID) vulnerability via defaultsDeep, merge, and mergeWith functions, which allows a malicious user to modify the prototype of &quot;Object&quot; via &lt;strong&gt;proto&lt;/strong&gt;, causing the addition or modification of an existing property that will exist on all objects.&lt;/p&gt;
              &lt;p&gt;&lt;strong&gt;Affected Packages&lt;/strong&gt;&lt;/p&gt;

      &lt;dl&gt;
          &lt;dt&gt;Octoapp&lt;/dt&gt;
          &lt;dd&gt;Ecosystem: npm&lt;/dd&gt;
          &lt;dd&gt;Severity: moderate&lt;/dd&gt;
          &lt;dd&gt;Versions: &amp;lt; 4.17.5&lt;/dd&gt;
            &lt;dd&gt;Fixed in: 4.17.5&lt;/dd&gt;
      &lt;/dl&gt;

              &lt;p&gt;&lt;strong&gt;References&lt;/strong&gt;&lt;/p&gt;

      &lt;ul&gt;
          &lt;li&gt;https://nvd.nist.gov/vuln/detail/CVE-2018-123&lt;/li&gt;
      &lt;/ul&gt;

          </content>
        </entry>
    </feed>

## Notifications

Users receive notifications for conversations in repositories they watch including:

- Issues and their comments
- Pull Requests and their comments
- Comments on any commits

Notifications are also sent for conversations in unwatched repositories when the user is involved including:

- @mentions
- Issue assignments
- Commits the user authors or commits
- Any discussion in which the user actively participates

All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints.

Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit.

Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.

    # Add authentication to your requests
    $ curl -I https://api.github.com/notifications
    HTTP/1.1 200 OK
    Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT
    X-Poll-Interval: 60

    # Pass the Last-Modified header exactly
    $ curl -I https://api.github.com/notifications
    $    -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT"
    > HTTP/1.1 304 Not Modified
    > X-Poll-Interval: 60

### Notification reasons

When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification.

Here's a list of potential `reason`s for receiving a notification:

Reason Name | Description
--- | ---
`assign` | You were assigned to the issue.
`author` | You created the thread.
`comment` | You commented on the thread.
`invitation` | You accepted an invitation to contribute to the repository.
`manual` | You subscribed to the thread (via an issue or pull request).
`mention` | You were specifically @mentioned in the content.
`review_requested` | You, or a team you're a member of, were requested to review a pull request.
`security_alert` | GitHub discovered a security vulnerability in your repository.
`state_change` | You changed the thread state (for example, closing an issue or merging a pull request).
`subscribed` | You're watching the repository.
`team_mention` | You were on a team that was mentioned.

Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different.

For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then @mentioned on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again.

### List notifications for the authenticated user

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

    get /notifications

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`all` | boolean | query | If `true`, show notifications marked as read.
`participating` | boolean | query | If `true`, only shows notifications in which the user is directly participating or mentioned.
`since` | string | query | Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`before` | string | query | Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/notifications

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /notifications')

#### Default response

    Status: 200 OK

    [
      {
        "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": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
          "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
          "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
          "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
          "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
          "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
          "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
          "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
          "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
          "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
          "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
          "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
          "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
          "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
          "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
          "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
          "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
          "git_url": "git:github.com/octocat/Hello-World.git",
          "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
          "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
          "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
          "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
          "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
          "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
          "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
          "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
          "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
          "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
          "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
          "ssh_url": "git@github.com:octocat/Hello-World.git",
          "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
          "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
          "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
          "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
          "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
          "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
          "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
        },
        "subject": {
          "title": "Greetings",
          "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123",
          "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123",
          "type": "Issue"
        },
        "reason": "subscribed",
        "unread": true,
        "updated_at": "2014-11-07T22:01:45Z",
        "last_read_at": "2014-11-07T22:01:45Z",
        "url": "https://api.github.com/notifications/threads/1"
      }
    ]

### Mark notifications as read

Marks all notifications as "read" removes it from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter `all=false`.

    put /notifications

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`last_read_at` | string | body | Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.

#### Code samples

##### Shell

    curl \
      -X PUT \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/notifications \
      -d '{"last_read_at":"last_read_at"}'

##### JavaScript (@octokit/core.js)

    await octokit.request('PUT /notifications', {
      last_read_at: 'last_read_at'
    })

#### Response

    Status: 205 Reset Content

### Get a thread

    get /notifications/threads/{thread_id}

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`thread_id` | integer | path |

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/notifications/threads/42

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /notifications/threads/{thread_id}', {
      thread_id: 42
    })

#### Default response

    Status: 200 OK

    {
      "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": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
        "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
        "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
        "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
        "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
        "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
        "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
        "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
        "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
        "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
        "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
        "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
        "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
        "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
        "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
        "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
        "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
        "git_url": "git:github.com/octocat/Hello-World.git",
        "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
        "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
        "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
        "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
        "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
        "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
        "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
        "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
        "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
        "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
        "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
        "ssh_url": "git@github.com:octocat/Hello-World.git",
        "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
        "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
        "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
        "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
        "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
        "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
        "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
      },
      "subject": {
        "title": "Greetings",
        "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123",
        "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123",
        "type": "Issue"
      },
      "reason": "subscribed",
      "unread": true,
      "updated_at": "2014-11-07T22:01:45Z",
      "last_read_at": "2014-11-07T22:01:45Z",
      "url": "https://api.github.com/notifications/threads/1"
    }

### Mark a thread as read

    patch /notifications/threads/{thread_id}

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`thread_id` | integer | path |

#### Code samples

##### Shell

    curl \
      -X PATCH \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/notifications/threads/42

##### JavaScript (@octokit/core.js)

    await octokit.request('PATCH /notifications/threads/{thread_id}', {
      thread_id: 42
    })

#### Response

    Status: 205 Reset Content

### Get a thread subscription for the authenticated user

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

    get /notifications/threads/{thread_id}/subscription

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`thread_id` | integer | path |

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/notifications/threads/42/subscription

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /notifications/threads/{thread_id}/subscription', {
      thread_id: 42
    })

#### Default response

    Status: 200 OK

    {
      "subscribed": true,
      "ignored": false,
      "reason": null,
      "created_at": "2012-10-06T21:34:12Z",
      "url": "https://api.github.com/notifications/threads/1/subscription",
      "thread_url": "https://api.github.com/notifications/threads/1"
    }

### Set a thread subscription

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

    put /notifications/threads/{thread_id}/subscription

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`thread_id` | integer | path |
`ignored` | boolean | body | Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.

#### Code samples

##### Shell

    curl \
      -X PUT \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/notifications/threads/42/subscription \
      -d '{"ignored":true}'

##### JavaScript (@octokit/core.js)

    await octokit.request('PUT /notifications/threads/{thread_id}/subscription', {
      thread_id: 42,
      ignored: true
    })

#### Default response

    Status: 200 OK

    {
      "subscribed": true,
      "ignored": false,
      "reason": null,
      "created_at": "2012-10-06T21:34:12Z",
      "url": "https://api.github.com/notifications/threads/1/subscription",
      "thread_url": "https://api.github.com/notifications/threads/1"
    }

### Delete a thread subscription

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set `ignore` to `true`.

    delete /notifications/threads/{thread_id}/subscription

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`thread_id` | integer | path |

#### Code samples

##### Shell

    curl \
      -X DELETE \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/notifications/threads/42/subscription

##### JavaScript (@octokit/core.js)

    await octokit.request('DELETE /notifications/threads/{thread_id}/subscription', {
      thread_id: 42
    })

#### Default Response

    Status: 204 No Content

### List repository notifications for the authenticated user

List all notifications for the current user.

    get /repos/{owner}/{repo}/notifications

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |
`all` | boolean | query | If `true`, show notifications marked as read.
`participating` | boolean | query | If `true`, only shows notifications in which the user is directly participating or mentioned.
`since` | string | query | Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`before` | string | query | Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/notifications

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /repos/{owner}/{repo}/notifications', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Default response

    Status: 200 OK

    [
      {
        "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": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
          "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
          "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
          "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
          "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
          "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
          "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
          "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
          "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
          "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
          "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
          "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
          "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
          "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
          "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
          "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
          "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
          "git_url": "git:github.com/octocat/Hello-World.git",
          "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
          "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
          "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
          "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
          "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
          "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
          "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
          "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
          "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
          "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
          "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
          "ssh_url": "git@github.com:octocat/Hello-World.git",
          "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
          "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
          "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
          "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
          "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
          "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
          "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
        },
        "subject": {
          "title": "Greetings",
          "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123",
          "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123",
          "type": "Issue"
        },
        "reason": "subscribed",
        "unread": true,
        "updated_at": "2014-11-07T22:01:45Z",
        "last_read_at": "2014-11-07T22:01:45Z",
        "url": "https://api.github.com/notifications/threads/1"
      }
    ]

### Mark repository notifications as read

Marks all notifications in a repository as "read" removes them from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter `all=false`.

    put /repos/{owner}/{repo}/notifications

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |
`last_read_at` | string | body | Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.

#### Code samples

##### Shell

    curl \
      -X PUT \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/notifications \
      -d '{"last_read_at":"last_read_at"}'

##### JavaScript (@octokit/core.js)

    await octokit.request('PUT /repos/{owner}/{repo}/notifications', {
      owner: 'octocat',
      repo: 'hello-world',
      last_read_at: 'last_read_at'
    })

#### Response

    Status: 205 Reset Content

## Starring

Repository starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed.

### Starring vs. Watching

In August 2012, we changed the way watching works on GitHub. Many API client applications may be using the original "watcher" endpoints for accessing this data. You can now start using the "star" endpoints instead (described below). For more information, see the Watcher API Change post and the "Repository Watching API."

### Custom media types for starring

There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`.

    application/vnd.github.v3.star+json

For more information about media types, see "Custom media types."

### List stargazers

Lists the people that have starred the repository.

You can also find out when stars were created by passing the following custom media type via the `Accept` header:

    get /repos/{owner}/{repo}/stargazers

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/stargazers

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /repos/{owner}/{repo}/stargazers', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Default response

    Status: 200 OK

    [
      {
        "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
      }
    ]

#### Notes

- Works with GitHub Apps

### List repositories starred by the authenticated user

Lists repositories the authenticated user has starred.

You can also find out when stars were created by passing the following custom media type via the `Accept` header:

    get /user/starred

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`sort` | string | query | One of `created` (when the repository was starred) or `updated` (when it was last pushed to).
`direction` | string | query | One of `asc` (ascending) or `desc` (descending).
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/user/starred

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /user/starred')

#### Default response

    Status: 200 OK

    [
      {
        "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": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
        "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
        "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
        "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
        "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
        "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
        "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
        "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
        "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
        "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
        "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
        "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
        "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
        "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
        "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
        "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
        "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
        "git_url": "git:github.com/octocat/Hello-World.git",
        "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
        "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
        "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
        "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
        "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
        "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
        "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
        "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
        "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
        "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
        "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
        "ssh_url": "git@github.com:octocat/Hello-World.git",
        "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
        "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
        "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
        "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
        "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
        "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
        "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
        "clone_url": "https://github.com/octocat/Hello-World.git",
        "mirror_url": "git:git.example.com/octocat/Hello-World",
        "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
        "svn_url": "https://svn.github.com/octocat/Hello-World",
        "homepage": "https://github.com",
        "language": null,
        "forks_count": 9,
        "stargazers_count": 80,
        "watchers_count": 80,
        "size": 108,
        "default_branch": "master",
        "open_issues_count": 0,
        "is_template": true,
        "topics": [
          "octocat",
          "atom",
          "electron",
          "api"
        ],
        "has_issues": true,
        "has_projects": true,
        "has_wiki": true,
        "has_pages": false,
        "has_downloads": true,
        "archived": false,
        "disabled": false,
        "visibility": "public",
        "pushed_at": "2011-01-26T19:06:43Z",
        "created_at": "2011-01-26T19:01:12Z",
        "updated_at": "2011-01-26T19:14:43Z",
        "permissions": {
          "admin": false,
          "push": false,
          "pull": true
        },
        "allow_rebase_merge": true,
        "template_repository": null,
        "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
        "allow_squash_merge": true,
        "delete_branch_on_merge": true,
        "allow_merge_commit": true,
        "subscribers_count": 42,
        "network_count": 0
      }
    ]

### Check if a repository is starred by the authenticated user

    get /user/starred/{owner}/{repo}

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/user/starred/octocat/hello-world

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /user/starred/{owner}/{repo}', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Response if this repository is starred by you

    Status: 204 No Content

#### Response if this repository is not starred by you

    Status: 404 Not Found

### Star a repository for the authenticated user

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "HTTP verbs."

    put /user/starred/{owner}/{repo}

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |

#### Code samples

##### Shell

    curl \
      -X PUT \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/user/starred/octocat/hello-world

##### JavaScript (@octokit/core.js)

    await octokit.request('PUT /user/starred/{owner}/{repo}', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Default Response

    Status: 204 No Content

### Unstar a repository for the authenticated user

    delete /user/starred/{owner}/{repo}

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |

#### Code samples

##### Shell

    curl \
      -X DELETE \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/user/starred/octocat/hello-world

##### JavaScript (@octokit/core.js)

    await octokit.request('DELETE /user/starred/{owner}/{repo}', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Default Response

    Status: 204 No Content

### List repositories starred by a user

Lists repositories a user has starred.

You can also find out when stars were created by passing the following custom media type via the `Accept` header:

    get /users/{username}/starred

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`username` | string | path |
`sort` | string | query | One of `created` (when the repository was starred) or `updated` (when it was last pushed to).
`direction` | string | query | One of `asc` (ascending) or `desc` (descending).
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/users/USERNAME/starred

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /users/{username}/starred', {
      username: 'username'
    })

#### Default response

    Status: 200 OK

    [
      {
        "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": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
        "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
        "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
        "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
        "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
        "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
        "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
        "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
        "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
        "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
        "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
        "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
        "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
        "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
        "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
        "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
        "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
        "git_url": "git:github.com/octocat/Hello-World.git",
        "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
        "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
        "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
        "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
        "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
        "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
        "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
        "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
        "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
        "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
        "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
        "ssh_url": "git@github.com:octocat/Hello-World.git",
        "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
        "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
        "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
        "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
        "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
        "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
        "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
        "clone_url": "https://github.com/octocat/Hello-World.git",
        "mirror_url": "git:git.example.com/octocat/Hello-World",
        "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
        "svn_url": "https://svn.github.com/octocat/Hello-World",
        "homepage": "https://github.com",
        "language": null,
        "forks_count": 9,
        "stargazers_count": 80,
        "watchers_count": 80,
        "size": 108,
        "default_branch": "master",
        "open_issues_count": 0,
        "is_template": true,
        "topics": [
          "octocat",
          "atom",
          "electron",
          "api"
        ],
        "has_issues": true,
        "has_projects": true,
        "has_wiki": true,
        "has_pages": false,
        "has_downloads": true,
        "archived": false,
        "disabled": false,
        "visibility": "public",
        "pushed_at": "2011-01-26T19:06:43Z",
        "created_at": "2011-01-26T19:01:12Z",
        "updated_at": "2011-01-26T19:14:43Z",
        "permissions": {
          "admin": false,
          "push": false,
          "pull": true
        },
        "allow_rebase_merge": true,
        "template_repository": null,
        "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
        "allow_squash_merge": true,
        "delete_branch_on_merge": true,
        "allow_merge_commit": true,
        "subscribers_count": 42,
        "network_count": 0
      }
    ]

#### Notes

- Works with GitHub Apps

## Watching

Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. For simple repository bookmarks, see "Repository starring."

### List watchers

Lists the people watching the specified repository.

    get /repos/{owner}/{repo}/subscribers

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/subscribers

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /repos/{owner}/{repo}/subscribers', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Default response

    Status: 200 OK

    [
      {
        "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
      }
    ]

#### Notes

- Works with GitHub Apps

### Get a repository subscription

    get /repos/{owner}/{repo}/subscription

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/subscription

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /repos/{owner}/{repo}/subscription', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Response if you subscribe to the repository

    Status: 200 OK

    {
      "subscribed": true,
      "ignored": false,
      "reason": null,
      "created_at": "2012-10-06T21:34:12Z",
      "url": "https://api.github.com/repos/octocat/example/subscription",
      "repository_url": "https://api.github.com/repos/octocat/example"
    }

#### Response if you don t subscribe to the repository

    Status: 404 Not Found

### Set a repository subscription

If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, delete the repository's subscription completely.

    put /repos/{owner}/{repo}/subscription

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |
`subscribed` | boolean | body | Determines if notifications should be received from this repository.
`ignored` | boolean | body | Determines if all notifications should be blocked from this repository.

#### Code samples

##### Shell

    curl \
      -X PUT \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/subscription \
      -d '{"subscribed":true}'

##### JavaScript (@octokit/core.js)

    await octokit.request('PUT /repos/{owner}/{repo}/subscription', {
      owner: 'octocat',
      repo: 'hello-world',
      subscribed: true
    })

#### Default response

    Status: 200 OK

    {
      "subscribed": true,
      "ignored": false,
      "reason": null,
      "created_at": "2012-10-06T21:34:12Z",
      "url": "https://api.github.com/repos/octocat/example/subscription",
      "repository_url": "https://api.github.com/repos/octocat/example"
    }

### Delete a repository subscription

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

    delete /repos/{owner}/{repo}/subscription

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`owner` | string | path |
`repo` | string | path |

#### Code samples

##### Shell

    curl \
      -X DELETE \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/repos/octocat/hello-world/subscription

##### JavaScript (@octokit/core.js)

    await octokit.request('DELETE /repos/{owner}/{repo}/subscription', {
      owner: 'octocat',
      repo: 'hello-world'
    })

#### Default Response

    Status: 204 No Content

### List repositories watched by the authenticated user

Lists repositories the authenticated user is watching.

    get /user/subscriptions

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/user/subscriptions

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /user/subscriptions')

#### Default response

    Status: 200 OK

    [
      {
        "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": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
        "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
        "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
        "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
        "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
        "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
        "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
        "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
        "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
        "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
        "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
        "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
        "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
        "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
        "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
        "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
        "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
        "git_url": "git:github.com/octocat/Hello-World.git",
        "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
        "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
        "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
        "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
        "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
        "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
        "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
        "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
        "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
        "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
        "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
        "ssh_url": "git@github.com:octocat/Hello-World.git",
        "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
        "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
        "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
        "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
        "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
        "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
        "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
        "clone_url": "https://github.com/octocat/Hello-World.git",
        "mirror_url": "git:git.example.com/octocat/Hello-World",
        "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
        "svn_url": "https://svn.github.com/octocat/Hello-World",
        "homepage": "https://github.com",
        "language": null,
        "forks_count": 9,
        "stargazers_count": 80,
        "watchers_count": 80,
        "size": 108,
        "default_branch": "master",
        "open_issues_count": 0,
        "is_template": true,
        "topics": [
          "octocat",
          "atom",
          "electron",
          "api"
        ],
        "has_issues": true,
        "has_projects": true,
        "has_wiki": true,
        "has_pages": false,
        "has_downloads": true,
        "archived": false,
        "disabled": false,
        "visibility": "public",
        "pushed_at": "2011-01-26T19:06:43Z",
        "created_at": "2011-01-26T19:01:12Z",
        "updated_at": "2011-01-26T19:14:43Z",
        "permissions": {
          "admin": false,
          "push": false,
          "pull": true
        },
        "template_repository": null,
        "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
        "delete_branch_on_merge": true,
        "subscribers_count": 42,
        "network_count": 0,
        "license": {
          "key": "mit",
          "name": "MIT License",
          "spdx_id": "MIT",
          "url": "https://api.github.com/licenses/mit",
          "node_id": "MDc6TGljZW5zZW1pdA=="
        }
      }
    ]

### List repositories watched by a user

Lists repositories a user is watching.

    get /users/{username}/subscriptions

#### Parameters

Name | Type | In | Description
--- | --- | --- | ---
`accept` | string | header | Setting to `application/vnd.github.v3+json` is recommended
`username` | string | path |
`per_page` | integer | query | Results per page (max 100)
`page` | integer | query | Page number of the results to fetch.

#### Code samples

##### Shell

    curl \
      -H "Accept: application/vnd.github.v3+json" \
      https://api.github.com/users/USERNAME/subscriptions

##### JavaScript (@octokit/core.js)

    await octokit.request('GET /users/{username}/subscriptions', {
      username: 'username'
    })

#### Default response

    Status: 200 OK

    [
      {
        "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": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
        "assignees_url": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}",
        "blobs_url": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
        "branches_url": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}",
        "collaborators_url": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
        "comments_url": "http://api.github.com/repos/octocat/Hello-World/comments{/number}",
        "commits_url": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}",
        "compare_url": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
        "contents_url": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}",
        "contributors_url": "http://api.github.com/repos/octocat/Hello-World/contributors",
        "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments",
        "downloads_url": "http://api.github.com/repos/octocat/Hello-World/downloads",
        "events_url": "http://api.github.com/repos/octocat/Hello-World/events",
        "forks_url": "http://api.github.com/repos/octocat/Hello-World/forks",
        "git_commits_url": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
        "git_refs_url": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
        "git_tags_url": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
        "git_url": "git:github.com/octocat/Hello-World.git",
        "issue_comment_url": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
        "issue_events_url": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
        "issues_url": "http://api.github.com/repos/octocat/Hello-World/issues{/number}",
        "keys_url": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
        "labels_url": "http://api.github.com/repos/octocat/Hello-World/labels{/name}",
        "languages_url": "http://api.github.com/repos/octocat/Hello-World/languages",
        "merges_url": "http://api.github.com/repos/octocat/Hello-World/merges",
        "milestones_url": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}",
        "notifications_url": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
        "pulls_url": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}",
        "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}",
        "ssh_url": "git@github.com:octocat/Hello-World.git",
        "stargazers_url": "http://api.github.com/repos/octocat/Hello-World/stargazers",
        "statuses_url": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
        "subscribers_url": "http://api.github.com/repos/octocat/Hello-World/subscribers",
        "subscription_url": "http://api.github.com/repos/octocat/Hello-World/subscription",
        "tags_url": "http://api.github.com/repos/octocat/Hello-World/tags",
        "teams_url": "http://api.github.com/repos/octocat/Hello-World/teams",
        "trees_url": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
        "clone_url": "https://github.com/octocat/Hello-World.git",
        "mirror_url": "git:git.example.com/octocat/Hello-World",
        "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks",
        "svn_url": "https://svn.github.com/octocat/Hello-World",
        "homepage": "https://github.com",
        "language": null,
        "forks_count": 9,
        "stargazers_count": 80,
        "watchers_count": 80,
        "size": 108,
        "default_branch": "master",
        "open_issues_count": 0,
        "is_template": true,
        "topics": [
          "octocat",
          "atom",
          "electron",
          "api"
        ],
        "has_issues": true,
        "has_projects": true,
        "has_wiki": true,
        "has_pages": false,
        "has_downloads": true,
        "archived": false,
        "disabled": false,
        "visibility": "public",
        "pushed_at": "2011-01-26T19:06:43Z",
        "created_at": "2011-01-26T19:01:12Z",
        "updated_at": "2011-01-26T19:14:43Z",
        "permissions": {
          "admin": false,
          "push": false,
          "pull": true
        },
        "template_repository": null,
        "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
        "delete_branch_on_merge": true,
        "subscribers_count": 42,
        "network_count": 0,
        "license": {
          "key": "mit",
          "name": "MIT License",
          "spdx_id": "MIT",
          "url": "https://api.github.com/licenses/mit",
          "node_id": "MDc6TGljZW5zZW1pdA=="
        }
      }
    ]

#### Notes

- Works with GitHub Apps

#### Did this doc help you?

Want to learn about new docs features and updates? Sign up for updates!

We're continually improving our docs. We'd love to hear how we can do better.

What problem did you have? Required

Let us know what we can do better Optional

Can we contact you if we have more questions? Optional

Thank you! Your feedback has been submitted.

### Ask a human

#### Can't find what you're looking for?

Contact us