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: 100 · default: 10optional

Limits the project of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

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

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/content/active-documents'

200

404

422

429

200

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

OK