Skip to main content
GET
List the notifications a run owes
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns one page of the notifications the run owes for one attempt: the event (its kind, title, summary and, for a step’s notification, its node), the channel (bell, slack or email), whether it targets a person or a Slack channel (targetKind), its delivery state, timing, attempts, lastError (credential-shaped strings masked), the obligation that superseded it and when and why it was repaired. Never the recipient, the person or Slack channel it targets, the delivered notification or who repaired it.

Attempts and paging

attempt defaults to the run’s current attempt. An attempt the run never made answers 400 “Invalid attempt”; GET /api/v2/runs/getProvenance lists the run’s attempts. limit is 1 to 100 (default 50). Follow meta.nextCursor as cursor while meta.hasMore is true. A cursor the server cannot read answers 400.

Visibility

You need runs:read at the run’s home (its own org unit, else its workflow’s owning org unit) and at every company it carries, the same rule as GET /api/v2/runs/get. Any other run, and a run with neither home, answers 404 “Run not found” like a missing one. A Personal key reads as its owner, cut down to the key’s scopes; an External App reads by its own role grants.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

runId
string
required

The run id.

Minimum string length: 1

Query Parameters

attempt
integer

The run attempt. Default: the run's current attempt.

Required range: x >= 1
cursor
string

The opaque meta.nextCursor from the previous page.

Minimum string length: 1
limit
integer
default:50

Rows per page, 1-100. Default 50.

Required range: 1 <= x <= 100

Response

One page of notification obligations

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.