v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-03-2585861610.1 MB

orgs

Get announcement banner for organization

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint.

get/orgs/{org}/announcement

Path parameters

orgstring required

The organization name. The name is not case sensitive.

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\""
}