Search

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

List active documents for users

get

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

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the project of results to return

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

useFTSearchbooleanOptional

Get results from the new full text search index

querystringOptional

Full text search on documents body

authorIdsstring · uuid[] | nullableOptional

Filter documents that were edited by at least one user from the list

tagsstring[] | nullableOptional

Filter documents that have at least one of the provided tags

folderPathsstring[] | nullableOptional

Paths of the folder. This can be used to narrow search to a specific folder

orderBystringOptional

Special ordering setting for the result documents

Example: createdAt:asc

titlestring | nullableOptional

Filter documents based on title

Responses

200

OK

application/json

404

Not found

application/json

422

Validation error

application/json

429

Too many requests

application/json

get

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

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/content/active-documents HTTP/1.1
Host: 
Accept: */*

{
  "results": [
    {
      "authors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "body": "text",
      "createdAt": "2025-12-28T20:08:59.027Z",
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "status": "draft",
      "tags": [
        "text"
      ],
      "title": "text",
      "updatedAt": "2025-12-28T20:08:59.027Z"
    }
  ],
  "nextPageToken": "text"
}