Skip to content
bynhDocs
Log in

List incidents

GET/workspaces/{workspace}/status/incidents

Returns up to 100 incidents, newest first, with counts and how many confirmed subscribers would hear about new ones.

Authentication

Send an API token as a bearer token. This endpoint needs a read token, made by any member of the workspace. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

  • workspacestringRequired

    Your workspace slug, e.g. dokan.

Query parameters

  • filterenumdefault all

    open: not resolved. One of open, resolved, all.

Response

200 OK

Incidents without updates, meta {counts {open, resolved, all}, subscribers}.

  • idintegerIncident id.
  • titlestringTitle.
  • statusenumCurrent stage. One of investigating, identified, monitoring, resolved.
  • status_labelstringLocalized.
  • impactenumWorst impact across its components. One of operational, maintenance, degraded, partial_outage, major_outage.
  • impact_labelstringLocalized.
  • sourceenumautomatic: opened by a monitor. One of manual, automatic.
  • draftbooleanNot yet posted (published_at is null).
  • notify_subscribersbooleanSubscribers get emails for it.
  • started_atstringISO 8601.
  • published_atstring|nullISO 8601.
  • resolved_atstring|nullISO 8601.
  • duration_minutesintegerAt least 1; counts to now while open.
  • monitor{id, name}|nullMonitor that opened it.
  • components[]{id, name, impact, impact_label}Affected components.
  • updates_countinteger|nullNumber of updates.
  • updates[]objectid, status, status_label, body, author (name|null), notified_at, created_at. Empty in lists.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute. When you go over, wait for the number of seconds in Retry-After.

Errors

401The token is missing, wrong, revoked or expired.
404The token belongs to another workspace, or its owner is no longer a member.
422Unknown filter.

Every error is JSON with a message. See Errors.

Next →Report an incident
curl "https://api.bynh.io/api/v1/workspaces/dokan/status/incidents?filter=open" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": [
    {
      "id": 19,
      "title": "Checkout is slow",
      "status": "identified",
      "status_label": "Identified",
      "impact": "degraded",
      "impact_label": "Degraded",
      "source": "manual",
      "draft": false,
      "notify_subscribers": true,
      "started_at": "2026-10-01T06:40:00+00:00",
      "published_at": "2026-10-01T06:41:12+00:00",
      "resolved_at": null,
      "duration_minutes": 80,
      "monitor": null,
      "components": [
        {
          "id": 2,
          "name": "Checkout",
          "impact": "degraded",
          "impact_label": "Degraded"
        }
      ],
      "updates_count": 2,
      "updates": []
    }
  ],
  "meta": {
    "counts": {
      "open": 1,
      "resolved": 17,
      "all": 18
    },
    "subscribers": 243
  }
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.