v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Knowledge Connectors

Get Knowledge Connectors

Gets a list of Knowledge Connectors.

get/v2.0/knowledgestores/{knowledgeStoreId}/connectors

Path parameters

knowledgeStoreIdstring required

The Id of the KnowledgeStore

Query parameters

filterstring

The name of the knowledge connector to filter the records

limitinteger

The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100.

skipinteger

The number of items to skip before returning the results. Use this parameter with limit for offset-based pagination. The default value is 0.

sortstring

The order in which results are returned. Set a sorting rule in the format field:direction, where direction can be asc for ascending order or desc for descending order. For example, name:asc sorts by name in ascending order.

nextstring

The cursor that points to the next page of results. Use the nextCursor value returned in a previous response to request the next set of items.

previousstring

The cursor that points to the previous page of results. Use the previousCursor value returned in a previous response to request the previous set of items.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns array of a KnowledgeStore metadata objects

totalinteger
nextCursorstring
previousCursorstring

Example response

{
  "items": [
    {
      "extension": "confluence",
      "version": "1.1.0",
      "type": "MyConfluenceConnector",
      "name": "My Knowledge Connector",
      "schedule": {
        "enabled": true,
        "start": 1694518620,
        "totalMinutes": 1,
        "hour": 1,
        "minute": 1,
        "timezone": "UTC",
        "weekDays": [
          0,
          3
        ]
      },
      "lastExecution": 1694518620,
      "createdAt": 1694518620,
      "lastChanged": 1694518620
    }
  ],
  "total": 1
}