Ga naar inhoud
buildinglinksbuildinglinks

List anchors

GET
/api/v1/notary/anchors
curl --request GET \
  --url https://example.com/api/v1/notary/anchors \
  --cookie bl_authority_session=<bl_authority_session>

The anchors of all participants or one, newest first.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
participant
string

Only the anchors of this DID.

limit
integer format: int64

At most this many, up to 1000; default 200.

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>

An anchor in the notary’s list.

object
id
required
string
did
required

The participant.

string
participant_did
required
string
participant_name
string | null
seq
required
integer format: int64
head
required
string
count

The number of entries the participant reported.

integer | null format: int64
anchored_at
required
string format: date-time
receipt
required
string
next_cursor

Pass as cursor for the next page.

string | null

Example generated

{
  "items": [
    {
      "id": "example",
      "did": "example",
      "participant_did": "example",
      "participant_name": "example",
      "seq": 1,
      "head": "example",
      "count": 1,
      "anchored_at": "2026-04-15T12:00:00Z",
      "receipt": "example"
    }
  ],
  "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"
  }
}