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

GetAnnouncementBanner

client.organizations.announcementBanner.get(AnnouncementBannerGetParams { organizationId } body, RequestOptionsoptions?): AnnouncementBannerGetResponse { banner }
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
body: AnnouncementBannerGetParams { organizationId }
organizationId: string

organization_id is the ID of the organization

formatuuid
ReturnsExpand Collapse
AnnouncementBannerGetResponse { banner }

GetAnnouncementBanner

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const announcementBanner = await client.organizations.announcementBanner.get({
  organizationId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
});

console.log(announcementBanner.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"
  }
}