Sign in
Docs
API referenceStatus pages

API reference

List status notices

Have a token? Manage tokens in the console
GET
/v1/accounts/orgs/{org_id}/status-pages/{page_id}/notices

A page's public incidents and maintenance, newest first, each with its updates.

Needs scope connections:read.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

org_id*string

The account's id: org in GET /v1/me.

page_id*string

The page's id, from List status pages.

Query Parameters

page_size?integer

At most this many; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

Response Body

iohr.connections.v1.ListStatusNoticesResponse

application/json
  1. response

iohr.connections.v1.ListStatusNoticesResponse

next_page_token*string
notices*array<>
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const statusNotice of api.connections.allListStatusNotices("<org_id>", "<page_id>")) {    console.log(statusNotice);  }} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "next_page_token": "string",  "notices": [    {      "ends_at": "string",      "id": "string",      "impacts": [        {          "component_id": "string",          "impact": "string"        }      ],      "incident_id": "string",      "kind": "string",      "resolved_at": "string",      "starts_at": "string",      "state": "string",      "title": "string",      "updates": [        {          "body": "string",          "by_role": "string",          "created_at": "string",          "id": "string",          "state": "string"        }      ]    }  ]}