Ga naar inhoud
buildinglinksbuildinglinks

List invites

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

Authorizations

Section titled “Authorizations”

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>
object
code
required
string
name
required

Who the invite is for.

string
roles
required

The roles it pre-approves.

Array<string>
expires_at
string | null format: date-time
used_by

The DID that used it.

string | null
created_at

Absent in the answer to creating one.

string | null format: date-time
next_cursor

Pass as cursor for the next page.

string | null

Example generated

{
  "items": [
    {
      "code": "example",
      "name": "example",
      "roles": [
        "example"
      ],
      "expires_at": "2026-04-15T12:00:00Z",
      "used_by": "example",
      "created_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"
  }
}