v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB

enterprise-admin

Get announcement banner for enterprise

Gets the announcement banner currently set for the enterprise.

get/enterprises/{enterprise}/announcement

Path parameters

enterprisestring required

The slug version of the enterprise name.

Response

announcementstring nullable required

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."

expires_atstring date-time nullable required

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

user_dismissibleboolean nullable required

Whether an announcement can be dismissed by the user.

Example response

{
  "announcement": "Very **important** announcement about _something_.",
  "expires_at": "\"2021-01-01T00:00:00.000-07:00\""
}