Skip to main content

notifications

Overview

Namenotifications
TypeResource
Idgithub.activity.notifications

Fields

NameDatatypeDescription
idstring
subjectobject
urlstring
repositoryobjectMinimal Repository
subscription_urlstring
unreadboolean
updated_atstring
reasonstring
last_read_atstring

Methods

NameAccessible byRequired ParamsDescription
get_threadSELECTthread_idGets information about a notification thread.
list_notifications_for_authenticated_userSELECTList all notifications for the current user, sorted by most recently updated.
list_repo_notifications_for_authenticated_userSELECTowner, repoLists all notifications for the current user in the specified repository.
mark_notifications_as_readEXECMarks 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.
mark_repo_notifications_as_readEXECowner, repoMarks 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.
mark_thread_as_readEXECthread_idMarks 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.