Skip to main content
GET
List knowledge source providers
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/knowledge/synchronized-sources/listProviders lists the registered synchronized_knowledge providers, ordered by label: the providerKey that Connect a knowledge source takes, its label, the modes it declares, the source configuration it declares and the kinds it delivers. It never returns a connection, vendor or credential detail. MCP hosts call it through forge_call_operation with operationId listSynchronizedSourceProviders. It needs both knowledge:manage and credentials:use, the pair connecting a source requires, and the credential’s scopes must reach both. A credential missing either answers 403 permission_denied naming it, recorded. The route takes no query parameter but limit and cursor; any other answers 400 bad_request. The response is { data: [{ providerKey, label, modes, sourceConfig?, provides }], meta }: every registered provider is returned, in one response without limit, or in pages of limit with cursor. A deployment with no registered provider answers an empty list. modes accepts only synchronize, the supported mode. The Console uses it automatically; records are copied in on a schedule. Connecting a source in a retired mode answers 400 bad_request.
  • sourceConfig, when the provider declares one, is what a source of it takes: its fields (the only config keys createSource accepts for it, each with its label, help, type of string, number or select, and whether it is required), its container (what externalContainerId names, and whether the provider lists them), curatedApplicable, recommendedIntervalMinutes, and derivedKeys, the settings a sync derives and no caller may set. A provider without one takes free-form non-secret settings.
  • provides lists the kinds of record the provider delivers: each kind, its displayName, whether it is searchable, and its sensitiveAttributes, which are kept out of search.
A Freshservice source, for example, takes its workspace id as externalContainerId and no config: its account is derived from the freshservice/helpdesk credential on the first sync.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer

Items per page, 1 to 1000; a larger value is a 400 too_big. Omitted, the page is the whole list. The list is read whole.

Required range: 1 <= x <= 1000
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Knowledge source providers

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.