FruxonDocs
ApiCollection sources

Lists the tenant's reusable collection sources.

Returns a paginated list of the operator-owned sources defined in the tenant, each with its fetch config (tool / inline / RAG index) and record-to-processor input mapping.

GET
/v1/tenants/{tenant}/collectionSources
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

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.

orderBy?

Sort order (AIP-132 orderBy).

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/collectionSources"
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "tenantId": "00000000-0000-0000-0000-000000000000",
      "createdAt": 0,
      "modifiedAt": 0,
      "displayName": "string",
      "active": false,
      "source": {
        "kind": "UNSPECIFIED",
        "ragAssetId": "string",
        "ragReadMode": "UNSPECIFIED",
        "ragSearch": "string",
        "pageSize": null,
        "integrationConfigId": "string",
        "integrationId": "string",
        "listToolId": "string",
        "getToolId": "string",
        "recordsPath": "string",
        "cursorParamName": "string",
        "totalPath": "string",
        "pageOrder": "UNSPECIFIED",
        "parameters": {},
        "itemIdPath": "string",
        "itemVersionPath": "string",
        "previousVersionField": "string",
        "sinkTargetPath": "string",
        "sinkTargetKind": "UNSPECIFIED",
        "skipWhen": null,
        "sourceUrlPath": "string",
        "cursorPath": "string",
        "watermarkParamName": "string",
        "watermarkFormat": "UNSPECIFIED",
        "overlapWindowMs": 0,
        "startFrom": null,
        "flattenSheetRows": false
      },
      "inputMapping": {
        "userQuery": "string",
        "parameters": {},
        "attachmentUrlPath": "string"
      }
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}