Skip to main content

notifications

Overview

Namenotifications
TypeResource
Idgithub.activity.notifications

Fields

NameDatatypeDescription
idstring
subjectobject
urlstring
updated_atstring
last_read_atstring
unreadboolean
reasonstring
subscription_urlstring
repositoryobjectMinimal Repository

Methods

NameAccessible byRequired ParamsDescription
get_threadSELECTthread_id
list_notifications_for_authenticated_userSELECTList all notifications for the current user, sorted by most recently updated.
list_repo_notifications_for_authenticated_userSELECTowner, repoList all notifications for the current user.
mark_notifications_as_readEXECMarks 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.
mark_repo_notifications_as_readEXECowner, repoMarks 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.
mark_thread_as_readEXECthread_id