Docs
API ReferenceReferenceKnowledgebases

List website crawls

GET
/knowledgebases/{knowledgebaseId}/crawls

The websites crawled into this knowledgebase, with their include/exclude paths, cadence, status, last run, last error and how many pages each holds. The pages themselves are sources. Requires the knowledge:read scope.

AuthorizationBearer <token>

An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).

In: header

Path Parameters

knowledgebaseId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/knowledgebases/497f6eca-6276-4993-bfeb-53cbbbba6f08/crawls"
{  "knowledgebaseId": "2eaa043e-18a5-42f0-bbe8-1ad77d6f870c",  "crawls": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "knowledgebaseId": "2eaa043e-18a5-42f0-bbe8-1ad77d6f870c",      "url": "string",      "name": "string",      "include": [        "string"      ],      "exclude": [        "string"      ],      "maxPages": 0,      "cadence": "manual",      "status": "idle",      "lastSyncedAt": "2019-08-24T14:15:22Z",      "lastError": "string",      "pages": 0,      "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",      "creditsPerPage": 0,      "lastRunCredits": 0    }  ]}