ALallquiet
StatusPageResource

Get a status page by ID

Returns a single status page configuration, including branding, services, and visibility settings.

Required API key permissions

  • Scope: status-pages:get
  • Accepted key types: organization API key (org-wide), personal access token (org-wide)
  • Access: Operates on a single organization. Pass organizationId when your API key spans multiple organizations.
  • Required organization role (user-linked keys only): Member
  • Organization API keys are not subject to organization or team role checks.
get/api/public/v1/status-page/{id}

Request

Path parameters

idstring uuid required

Query parameters

organizationIdstring uuid

Response

OK

idstring uuid
isProvisionedboolean
displayNamestring nullable
publicTitlestring nullable
publicDescriptionstring nullable
slugstring nullable
timeZoneIdstring nullable
publicCompanyNamestring nullable
publicCompanyUrlstring nullable
publicSupportUrlstring nullable
publicSupportEmailstring nullable
historyInDaysinteger
disablePublicSubscriptionboolean
disablePublicPageboolean nullable
disablePublicJsonboolean nullable
publicSeverityMappingMinorstring nullable
publicSeverityMappingWarningstring nullable
publicSeverityMappingCriticalstring nullable
serviceIdsstring[] nullable
publicBannerBackgroundColorstring nullable
publicBannerBackgroundColorDarkModestring nullable
publicBannerTextColorstring nullable
publicBannerTextColorDarkModestring nullable
bannerBackgroundColorstring nullable
bannerBackgroundColorDarkModestring nullable
bannerTextColorstring nullable
bannerTextColorDarkModestring nullable
bodyBackgroundColorstring nullable
bodyBackgroundColorDarkModestring nullable
secondaryBackgroundColorstring nullable
secondaryBackgroundColorDarkModestring nullable
primaryTextColorstring nullable
primaryTextColorDarkModestring nullable
secondaryTextColorstring nullable
secondaryTextColorDarkModestring nullable
buttonBackgroundColorstring nullable
buttonBackgroundColorDarkModestring nullable
buttonTextColorstring nullable
buttonTextColorDarkModestring nullable
privateIpFilterstring nullable
privateUserAuthenticationRequiredboolean nullable
enableSMSSubscriptionboolean nullable
decimalPlacesinteger nullable
publicDisplayLiveStateOnlyboolean
publicHideIncidentDetailsboolean
publicHideMaintenancesboolean
isPasswordProtectionPasswordConfiguredboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.