retrieval

List retrieval sources

List the external retrieval sources connected to an environment, oldest first. Credentials are not returned.

Required permission: retrieval.view.

get/v1/projects/{project_id}/retrieval/sources

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/retrieval/sources
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Query parameters

environment_idstring uuid required

Environment ID from GET /environments.

Response

Successful Response

idstring required
environment_idstring required

Environment the source syncs into.

typestring required

Source type: notion, confluence (Confluence Cloud), coda (Superhuman Docs), zendesk (Zendesk Help Center), or website.

namestring required
configobject required

Provider settings without integration_token and api_token.

statusstring required

active, or error after a failed sync. Updating config resets error to active.

last_synced_atstring nullable required

Start time of the most recent successful sync; null until one succeeds.

last_errorstring nullable required

Message from the most recent sync that failed or was skipped, or a JSON string with a file_issues list when it completed with file problems; null otherwise.

created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.