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

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the project of results to return

pageTokenstring · max: 8000

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

reverseboolean

Order in which to retrieve the results

useFTSearchboolean

Get results from the new full text search index

querystring

Full text search on documents body

authorIdsstring · uuid[] | nullable

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

tagsstring[] | nullable

Filter documents that have at least one of the provided tags

folderPathsstring[] | nullable

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

orderBystring

Special ordering setting for the result documents

Example: createdAt:asc

titlestring | nullable

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": [
    {
      "body": "text",
      "createdAt": "2025-02-21T18:02:56.326Z",
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "title": "text",
      "updatedAt": "2025-02-21T18:02:56.326Z",
      "status": "draft",
      "authors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "tags": [
        "text"
      ]
    }
  ],
  "nextPageToken": "text"
}

OK