Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations
Announcement Banner

GetAnnouncementBanner

organizations.announcement_banner.get(AnnouncementBannerGetParams**kwargs) -> AnnouncementBannerGetResponse
POST/gitpod.v1.OrganizationService/GetAnnouncementBanner

Retrieves the announcement banner configuration for an organization.

Use this method to fetch the current announcement banner settings. All organization members can read the banner configuration.

Examples

  • Get announcement banner:

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
ParametersExpand Collapse
organization_id: str

organization_id is the ID of the organization

formatuuid
ReturnsExpand Collapse
class AnnouncementBannerGetResponse: …

GetAnnouncementBanner

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
announcement_banner = client.organizations.announcement_banner.get(
    organization_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
)
print(announcement_banner.banner)
{
  "banner": {
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "enabled": true,
    "message": "message"
  }
}
Returns Examples
{
  "banner": {
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "enabled": true,
    "message": "message"
  }
}