FruxonDocs
ApiConsult pins

Lists consult pins, ordered by capability then scope.

With agentId set, returns every pin that affects that agent — its own overrides plus the tenant-global defaults it inherits. Without it, returns the tenant's full pin set (all agents + globals). The set is small and unpaged today; the `ListPage` envelope keeps paging part of the contract for when it grows.

GET
/v1/tenants/{tenant}/consultPins

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

Optional agent filter — returns that agent's overrides plus globals.

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/consultPins"
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "agentId": "string",
      "capability": "string",
      "participantId": "00000000-0000-0000-0000-000000000000",
      "createdAt": 0,
      "modifiedAt": 0
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}