FruxonDocs
Agent NetworkParticipants

Lists an agent's consult roster — its bound participants with consult metadata.

Returns one row per participant bound to `agentId`, each with its consult-roster settings (roles, consult allowed, urgency cap, default for roles) that drive `consult_for_role` resolution and the consult policy.

GET
/v1/tenants/{tenant}/participants/consultRoster

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

tenant*string

The tenant identifier

Query Parameters

agentId?string

The agent whose roster to list (required).

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque pagination token returned by an external service. Pass it back unchanged rather than interpreting it as an offset.

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/participants/consultRoster"
{
  "items": [
    {
      "participantId": "00000000-0000-0000-0000-000000000000",
      "agentId": "string",
      "displayName": "string",
      "kind": "PERSON",
      "avatarFileId": "string",
      "roles": [
        "string"
      ],
      "routableRoles": [
        "string"
      ],
      "consultAllowed": false,
      "maxUrgency": "LOW",
      "defaultForRoles": [
        "string"
      ],
      "responsePolicy": "ALWAYS",
      "venueBrief": "string"
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Patches the consult-roster metadata on one participant↔agent binding.

PATCH semantics: null fields are left unchanged; a supplied list replaces the stored one. `default_for_roles` must be a subset of `roles`. The `binding` route segment is the agent id (consistent with the bind sub-resource). 404 if the binding doesn't exist.

Deletes a participant and all its bindings.

Permanently removes the participant along with every agent binding attached to it, and every account the person connected under one of its addresses along with the connect links still open for them. An account another participant's address also reaches is kept. The delete does not cascade to the agents themselves, and agents' memories of the person stay; forget the person first to remove those. Returns 404 when the participant does not exist.