Ga naar inhoud
buildinglinksbuildinglinks

List outgoing messages

GET
/api/v1/outbox
curl --request GET \
  --url https://example.com/api/v1/outbox \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E

Messages of ours to counterparties (DSP and delegation), newest first. A message is tried again with backoff until it is delivered or too old; then it is failed and waits for an operator to send it again or drop it (decisions #56).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
status
string

pending, delivered, failed or dropped.

process_id
string

Only the messages of this negotiation, transfer or delegation.

limit
integer format: int64

At most this many, 1 to 1000; default 100.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

A page of a list. next_cursor is null on the last page.

object
items
required
Array<object>

A row of the outbox: a message of ours to a counterparty, until it is delivered or dropped (decisions #56).

object
id
required
integer format: int64
process_id
required

The negotiation, transfer or delegation the message belongs to.

string
kind
required
string
message_type
required
string
counterparty_did
required
string
url
required
string
evidence_id
required
string
status
required
string
attempts
required
integer format: int32
next_attempt_at
required
string format: date-time
last_error
string | null
response_status
integer | null format: int32
created_at
required
string format: date-time
resent_at
string | null format: date-time
delivered_at
string | null format: date-time
next_cursor

Pass as cursor for the next page.

string | null

Example generated

{
  "items": [
    {
      "id": 1,
      "process_id": "example",
      "kind": "example",
      "message_type": "example",
      "counterparty_did": "example",
      "url": "example",
      "evidence_id": "example",
      "status": "example",
      "attempts": 1,
      "next_attempt_at": "2026-04-15T12:00:00Z",
      "last_error": "example",
      "response_status": 1,
      "created_at": "2026-04-15T12:00:00Z",
      "resent_at": "2026-04-15T12:00:00Z",
      "delivered_at": "2026-04-15T12:00:00Z"
    }
  ],
  "next_cursor": "example"
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}