Dynamiq
Knowledge Bases

List knowledge base source syncs

Lists the synchronization runs of a source, most recent first, each reporting its status and start/end times.

GET
/v1/knowledgebase-sources/{source_id}/syncs

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Path Parameters

source_id*string

Knowledge base source UUID.

Query Parameters

page?integer

Page number (1-based).

page_size?integer

Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/knowledgebase-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08/syncs"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
      "status": "running",
      "started_at": "2019-08-24T14:15:22Z",
      "ended_at": "2019-08-24T14:15:22Z",
      "error": null
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 0,
    "page_count": 0,
    "total_count": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}