How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Notifications API

This GitHub REST API allows you to programmatically manage your GitHub notifications, which include updates on issues, pull requests, and commits. The API requires authentication via a personal access token (classic) and needs either the notifications or repo scope to function.

GitHub Notifications API is one of 384 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notifications. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}/api/v3.

2 operations 1 paths 5 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.1.4
Base URL
https://api.github.com/
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Notifications API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Notifications 2
GET
/repos/{owner}/{repo}/notifications
GitHub List Repository Notifications for the Authenticated User
listRepositoryNotificationsForTheAuthenticatedUser 11 params → 200
PUT
/repos/{owner}/{repo}/notifications
GitHub Mark Repository Notifications as Read
markRepositoryNotificationsAsRead 5 params body → 202205

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are minimal-repository (87 properties), simple-user (21 properties), thread (9 properties), code-of-conduct (5 properties). Each schema is shown below with its type and property counts.

simple-user
object
GitHub user.
21 properties 18 required
security-and-analysis
object
3 properties
minimal-repository
object
Minimal Repository
87 properties 46 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
thread
object
Thread
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-notifications-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
GitHub User API
Where this information came from

This is an independent, third-party profile of GitHub Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.