Undelivered notifications with their age. The operator's.

GET

/v1/notifications/undelivered

const url = 'https://example.com/v1/notifications/undelivered';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/notifications/undelivered \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

The answer, from one consistent view (REQ-QR-2).

application/json

Array<object>

An undelivered notification, with its age (REQ-EV-6).

object

age

required

How long it has been owed, in milliseconds.

integer format: uint64

notification

required

The notification.

object

anchor

Any of:

object
null

An anchor a notification names (REQ-EV-1, AC-M2.4): a final checkpoint of the book.

object

coordinate

required

Its Anchored record on the settlement layer.

object

digest

required

The entry’s digest, hex.

string

instance

required

The instance.

integer format: uint32

seq

required

The position in its inbox.

integer format: uint64

entry_sequence

required

The sequence of the last entry it commits to (REQ-PR-7).

integer format: uint64

height

required

The height of the block that wrote that record.

integer format: uint64

number

required

Its number: the settlement layer’s anchor number.

integer format: uint64

class

required

One of:

Terminal: the outcome is final.

string

Allowed value: terminal

Needs-Review: waiting for a human. Not terminal and not refunding.

string

Allowed value: awaiting-human

error

Any of:

Refusal
null

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

required

H(operation, transition), hex: stable across attempts (REQ-EV-3).

string

operation_reference

required

The operation.

string

outcome

The terminal state, where terminal.

string | null

reference

Any of:

unknown
null

Pass-through data (REQ-PO-5): any one JSON value, at most 1024 bytes of UTF-8 as sent. Kept and echoed exactly as sent; never read by aledgent. Over the bound, or not one JSON value, the command is refused with ERR-MalformedCommand.

state

required

The state it entered.

string

terminal

required

Whether it is terminal.

boolean

recipient

The principal it is owed to.

string | null

Example

[
  {
    "notification": {
      "class": "terminal",
      "error": {
        "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
        "error": "ERR-NotAuthorised"
      }
    }
  }
]

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).