Ga naar inhoud

Search the registry

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

The participants of the dataspace, by name. For users of the authority (any role), and for active members, whose connectors call with a DCP token; members do not see contact details and telemetry levels.

q
string

Search in name, legal name, KvK number and DID.

role
string

Only participants with this role.

limit
integer format: int64

A page of at most this many, up to 100; without it, the whole list.

cursor
string

The next_cursor of the page before.

OK.

Media typeapplication/json

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

object
items
required
Array<object>

A participant in the registry.

object
did
required
string
slug
required

Short name, used in addresses.

string
name
required
string
legal_name
required
string
kvk_number
required

Number in the Dutch trade register (KvK).

string
roles
required

The roles in the dataspace, e.g. provider, consumer.

Array<string>
dsp_endpoint
required

Where other connectors reach its Dataspace Protocol endpoints.

string
dataplane_url
string | null
color
string | null
status
required

active or suspended.

string
onboarded_at
required
string format: date-time
credential_id

The current membership credential.

string | null
health
required

What the monitoring of the authority last saw: e.g. healthy, degraded, unreachable.

string
last_seen_at
string | null format: date-time
telemetry_level

Operators only: how much the participant shares with the monitoring.

string | null
contact_email

Operators only.

string | null
next_cursor

Pass as cursor for the next page.

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",
"onboarded_at": "2026-04-15T12:00:00Z",
"credential_id": "example",
"health": "example",
"last_seen_at": "2026-04-15T12:00:00Z",
"telemetry_level": "example",
"contact_email": "example"
}
],
"next_cursor": "example"
}

Invalid cursor.

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

Not authenticated.

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

The calling participant is not an active member.

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