GitHubs Feeds API lets you programmatically discover the Atom feed URLs for GitHub activity thats relevant to you, such as the global timeline, a specific users activity, the authenticated users public and private activity, organization activity, and security advisories.
openapi: 3.2.0
info:
version: 1.1.4
title: GitHub Feeds API
description: 'Use the REST API to interact with GitHub feeds. Lists the feeds available
to the authenticated user. The response provides a URL for each feed. You
can then get a specific feed by sending a request to one of the feed URLs.'
license:
name: MIT
url: https://spdx.org/licenses/MIT
termsOfService: https://docs.github.com/articles/github-terms-of-service
contact:
name: Support
url: https://support.github.com/contact?tags=dotcom-rest-api
x-github-plan: ghes
x-github-release: 3.9
servers:
- url: '{protocol}://{hostname}/api/v3'
variables:
hostname:
description: Self-hosted Enterprise Server hostname
default: HOSTNAME
protocol:
description: Self-hosted Enterprise Server protocol
default: http
tags:
- name: Feeds
paths:
/feeds:
get:
summary: GitHub Get Feeds
description: 'GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) 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`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
* **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](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.'
tags:
- Feeds
operationId: getFeeds
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/feeds#get-feeds
parameters: []
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/feed'
examples:
default:
$ref: '#/components/examples/feed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: feeds
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
link-with-type:
title: Link With Type
description: Hypermedia Link with Type
type: object
properties:
href:
type: string
example: https://api.github.com/repos/octocat/Hello-World
type:
type: string
example: User
required:
- href
- type
feed:
title: Feed
description: Feed
type: object
properties:
timeline_url:
type: string
example: https://github.com/timeline
user_url:
type: string
example: https://github.com/{user}
current_user_public_url:
type: string
example: https://github.com/octocat
current_user_url:
type: string
example: https://github.com/octocat.private?token=abc123
current_user_actor_url:
type: string
example: https://github.com/octocat.private.actor?token=abc123
current_user_organization_url:
type: string
example: https://github.com/octocat-org
current_user_organization_urls:
type: array
example:
- https://github.com/organizations/github/octocat.private.atom?token=abc123
items:
type: string
format: uri
security_advisories_url:
type: string
example: https://github.com/security-advisories
repository_discussions_url:
type: string
example: https://github.com/{user}/{repo}/discussions
description: A feed of discussions for a given repository.
repository_discussions_category_url:
type: string
example: https://github.com/{user}/{repo}/discussions/categories/{category}
description: A feed of discussions for a given repository and category.
_links:
type: object
properties:
timeline:
$ref: '#/components/schemas/link-with-type'
user:
$ref: '#/components/schemas/link-with-type'
security_advisories:
$ref: '#/components/schemas/link-with-type'
current_user:
$ref: '#/components/schemas/link-with-type'
current_user_public:
$ref: '#/components/schemas/link-with-type'
current_user_actor:
$ref: '#/components/schemas/link-with-type'
current_user_organization:
$ref: '#/components/schemas/link-with-type'
current_user_organizations:
type: array
items:
$ref: '#/components/schemas/link-with-type'
repository_discussions:
$ref: '#/components/schemas/link-with-type'
repository_discussions_category:
$ref: '#/components/schemas/link-with-type'
required:
- timeline
- user
required:
- _links
- timeline_url
- user_url
examples:
feed:
value:
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
securitySchemes:
bearerHttpAuthentication:
description: Bearer Token
type: http
scheme: Bearer
externalDocs:
description: GitHub Enterprise Developer Docs
url: https://docs.github.com/enterprise-server@3.9/rest/