Search

API to do text search on a given workspace for knowledge base Documents.

List active documents for users

List active documents on a given workspace and folder for a knowledge base.

GET/workspaces/{workspaceId}/content/active-documents

Query parameters

Response

200404422429

OK

Body

application/json

resultsarray of Touchpoints_Document (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/active-documents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404422429

{
  "results": [
    {
      "authors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "body": "text",
      "createdAt": "2024-09-07T23:28:23.441Z",
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "status": "draft",
      "tags": [
        "text"
      ],
      "title": "text",
      "updatedAt": "2024-09-07T23:28:23.441Z"
    }
  ],
  "nextPageToken": "text"
}