StatusPageResourceSearch

Search for a single status page

Find one status page by exact display name within organizations visible to the caller. Returns 404 when no matching status page is found.

Required API key permissions

  • Scope: status-pages:get
  • Accepted key types: organization API key (org-wide), personal access token (org-wide)
  • Access: Access is checked against the specific resource (team or organization reachability).
  • Notes: Team-scoped API keys are not supported. User-linked keys without an explicit organization membership receive empty results.
get/api/public/v1/status-page/search

Request

Query parameters

DisplayNamestring
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 1 revision of this API.