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 Announcement API

The Announcement API from GitHub — 1 operation(s) for announcement.

GitHub Announcement API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include announcement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

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

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

3 operations 1 paths 5 schemas 1 DELETE1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 Announcement API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 3

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

Announcement 3
GET
/orgs/{org}/announcement
GitHub Get Announcement Banner for Organization
getAnnouncementBannerForOrganization 1 param → 200
PATCH
/orgs/{org}/announcement
GitHub Set Announcement Banner for Organization
setAnnouncementBannerForOrganization 1 param body → 200
DELETE
/orgs/{org}/announcement
GitHub Remove Announcement Banner from Organization
removeAnnouncementBannerFromOrganization 1 param → 204

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are announcement-banner (3 properties), announcement (2 properties). Each schema is shown below with its type and property counts.

announcement-message
stringnull
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs…
announcement-banner
object
Announcement at either the repository, organization, or enterprise level
3 properties 3 required
announcement
object
Enterprise global announcement
2 properties 1 required
announcement-user-dismissible
booleannull
Whether an announcement can be dismissed by the user.
announcement-expiration
stringnull
The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format: YYYY-MM-DDTHH:MM:SSZ. To set an an…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-announcement-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 Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Announcement 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.