← All tags

Activity API Reference

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

32 endpoints tagged activity, each listing its parameters and possible responses. Search or scroll the index below to jump to a specific endpoint.

No endpoints match your search.

List public events

GET /events

Parameters

Name	In	Required	Description
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
503	Service unavailable	yes

Get feeds

GET /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.

Parameters

No parameters.

Responses

Status	Description	Has JSON body
200	Response	yes

List public events for a network of repositories

GET /networks/{owner}/{repo}/events

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes
403	Forbidden	yes
304	Not modified	no
301	Moved permanently	yes

List notifications for the authenticated user

GET /notifications

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

Parameters

Name	In	Required	Description
`all`	query	no	If `true`, show notifications marked as read.
`participating`	query	no	If `true`, only shows notifications in which the user is directly participating or mentioned.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`before`	query	no	Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
`per_page`	query	no	The number of results per page (max 50). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes
422	Validation failed, or the endpoint has been spammed.	yes

Mark notifications as read

PUT /notifications

Marks all notifications as "read" for the current user. 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.

Parameters

No parameters.

Responses

Status	Description	Has JSON body
202	Response	yes
205	Reset Content	no
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Get a thread

GET /notifications/threads/{thread_id}

Gets information about a notification thread.

Parameters

Name	In	Required	Description
`thread_id`	path	yes	The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the `GET /notifications` operation).

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Mark a thread as read

PATCH /notifications/threads/{thread_id}

Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.

Parameters

Name	In	Required	Description
`thread_id`	path	yes	The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the `GET /notifications` operation).

Responses

Status	Description	Has JSON body
205	Reset Content	no
304	Not modified	no
403	Forbidden	yes

Mark a thread as done

DELETE /notifications/threads/{thread_id}

Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.

Parameters

Name	In	Required	Description
`thread_id`	path	yes	The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the `GET /notifications` operation).

Responses

Status	Description	Has JSON body
204	No content	no

Get a thread subscription for the authenticated user

GET /notifications/threads/{thread_id}/subscription

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

Parameters

Name	In	Required	Description
`thread_id`	path	yes	The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the `GET /notifications` operation).

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Set a thread subscription

PUT /notifications/threads/{thread_id}/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.

Parameters

Name	In	Required	Description
`thread_id`	path	yes	The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the `GET /notifications` operation).

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Delete a thread subscription

DELETE /notifications/threads/{thread_id}/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.

Parameters

Name	In	Required	Description
`thread_id`	path	yes	The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the `GET /notifications` operation).

Responses

Status	Description	Has JSON body
204	Response	no
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

List public organization events

GET /orgs/{org}/events

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List repository events

GET /repos/{owner}/{repo}/events

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List repository notifications for the authenticated user

GET /repos/{owner}/{repo}/notifications

Lists all notifications for the current user in the specified repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`all`	query	no	If `true`, show notifications marked as read.
`participating`	query	no	If `true`, only shows notifications in which the user is directly participating or mentioned.
`since`	query	no	Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`before`	query	no	Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

Mark repository notifications as read

PUT /repos/{owner}/{repo}/notifications

Marks all notifications in a repository as "read" for the current user. 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.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
202	Response	yes
205	Reset Content	no

List stargazers

GET /repos/{owner}/{repo}/stargazers

Lists the people that have starred the repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
422	Validation failed, or the endpoint has been spammed.	yes

List watchers

GET /repos/{owner}/{repo}/subscribers

Lists the people watching the specified repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

Get a repository subscription

GET /repos/{owner}/{repo}/subscription

Gets information about whether the authenticated user is subscribed to the repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	if you subscribe to the repository	yes
404	Not Found if you don't subscribe to the repository	no
403	Forbidden	yes

Set a repository subscription

PUT /repos/{owner}/{repo}/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.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes

Delete a repository subscription

DELETE /repos/{owner}/{repo}/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.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response	no

List repositories starred by the authenticated user

GET /user/starred

Lists repositories the authenticated user has starred.

Parameters

Name	In	Required	Description
`sort`	query	no	The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.
`direction`	query	no	The direction to sort the results by.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Check if a repository is starred by the authenticated user

GET /user/starred/{owner}/{repo}

Whether the authenticated user has starred the repository.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response if this repository is starred by you	no
404	Not Found if this repository is not starred by you	yes
401	Requires authentication	yes
304	Not modified	no
403	Forbidden	yes

Star a repository for the authenticated user

PUT /user/starred/{owner}/{repo}

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

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response	no
403	Forbidden	yes
404	Resource not found	yes
401	Requires authentication	yes
304	Not modified	no

Unstar a repository for the authenticated user

DELETE /user/starred/{owner}/{repo}

Unstar a repository that the authenticated user has previously starred.

Parameters

Name	In	Required	Description
`owner`	path	yes	The account owner of the repository. The name is not case sensitive.
`repo`	path	yes	The name of the repository without the `.git` extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
204	Response	no
404	Resource not found	yes
401	Requires authentication	yes
304	Not modified	no
403	Forbidden	yes

List repositories watched by the authenticated user

GET /user/subscriptions

Lists repositories the authenticated user is watching.

Parameters

Name	In	Required	Description
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

List events for the authenticated user

GET /users/{username}/events

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read).

Parameters

Name	In	Required	Description
`username`	path	yes	The handle for the GitHub user account.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List organization events for the authenticated user

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

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

Parameters

Name	In	Required	Description
`username`	path	yes	The handle for the GitHub user account.
`org`	path	yes	The organization name. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List public events for a user

GET /users/{username}/events/public

Parameters

Name	In	Required	Description
`username`	path	yes	The handle for the GitHub user account.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List events received by the authenticated user

GET /users/{username}/received_events

These are events that you've received by watching repositories and following users. If you are authenticated as the

Parameters

Name	In	Required	Description
`username`	path	yes	The handle for the GitHub user account.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List public events received by a user

GET /users/{username}/received_events/public

Parameters

Name	In	Required	Description
`username`	path	yes	The handle for the GitHub user account.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List repositories starred by a user

GET /users/{username}/starred

Lists repositories a user has starred.

Parameters

Name	In	Required	Description
`username`	path	yes	The handle for the GitHub user account.
`sort`	query	no	The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.
`direction`	query	no	The direction to sort the results by.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List repositories watched by a user

GET /users/{username}/subscriptions

Lists repositories a user is watching.

Parameters

Name	In	Required	Description
`username`	path	yes	The handle for the GitHub user account.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes