Ga naar inhoud
buildinglinksbuildinglinks

Participants of the dataspace

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

From the registry of the authority. Without parameters the whole list; with any of them a search that the registry pages.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string

Search text, as the registry matches it.

role
string

Only participants with this role.

limit
integer format: int32

1 to 100.

cursor
string

next_cursor of the previous page.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json
object
items
required
Array

A participant of the registry, as this connector shows it.

object
did
required
string
slug
required
string
name
required
string
legal_name
string
kvk_number
string | null
roles
Array<string>
dsp_endpoint
required
string
dataplane_url
string | null
color
string | null
status
required
string
health
string | null
is_self
required

This is us.

boolean
next_cursor

For the next page of a search; null without a search.

string | null

Example generated

{
  "items": [
    {
      "did": "example",
      "slug": "example",
      "name": "example",
      "legal_name": "example",
      "kvk_number": "example",
      "roles": [
        "example"
      ],
      "dsp_endpoint": "example",
      "dataplane_url": "example",
      "color": "example",
      "status": "example",
      "health": "example",
      "is_self": true
    }
  ],
  "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"
  }
}

502

Section titled “502”

A counterparty or an upstream service could not be reached.

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"
  }
}