Folders

List folder

List folders on a given workspace for a knowledge base.

GET/workspaces/{workspaceId}/content/folders

Path parameters

workspaceId*string

Query parameters

Response

200404422429

OK

Body

application/json

resultsarray of Touchpoints_Folder (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/folders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404422429

{
  "results": [
    {
      "createdAt": "2024-11-21T08:50:53.756Z",
      "icon": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "status": "draft",
      "updatedAt": "2024-11-21T08:50:53.756Z"
    }
  ],
  "nextPageToken": "text"
}

Create folder

Create a folder on a given workspace for a knowledge base.

POST/workspaces/{workspaceId}/content/folders

Path parameters

workspaceId*string

Body

application/json

iconnullable string

name*string

Folder name

parentFolderIdnullable string (uuid)

ID of the folder to store the new folder

parentFolderPathnullable string

Path of the folder to store the new folder

status*enum

Status of the folder. If you want your documents to be visible and used by other systems, make it 'active'

draftactiveinactive

Response

201404409422429

Created

Body

application/json

createdAt*string (date-time)

iconnullable string

id*string (uuid)

name*string

parentFolderIdstring (uuid)

path*string

slug*string

status*enum

draftactiveinactive

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/folders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "status": "draft"
    }),
});
const data = await response.json();

Response

201404409422429

{
  "createdAt": "2024-11-21T08:50:53.756Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "updatedAt": "2024-11-21T08:50:53.756Z"
}

Get folder

Get folders on a given workspace for a knowledge base.

GET/workspaces/{workspaceId}/content/folders/{contentPath}

Path parameters

workspaceId*string

contentPath*string

Response

200404422429

OK

Body

application/json

createdAt*string (date-time)

iconnullable string

id*string (uuid)

name*string

parentFolderIdstring (uuid)

path*string

slug*string

status*enum

draftactiveinactive

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200404422429

{
  "createdAt": "2024-11-21T08:50:53.756Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "updatedAt": "2024-11-21T08:50:53.756Z"
}

Delete folder

Delete a folder on a given workspace for a knowledge base.

DELETE/workspaces/{workspaceId}/content/folders/{contentPath}

Path parameters

workspaceId*string

contentPath*string

Response

204404422

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/folders/{contentPath}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

404422

{
  "code": "text",
  "message": "text"
}

Update folder

Update a folder on a given workspace for a knowledge base.

PATCH/workspaces/{workspaceId}/content/folders/{contentPath}

Path parameters

workspaceId*string

contentPath*string

Body

application/json

iconnullable string

namestring

Folder name

statusenum

Status of the folder. If you want your documents to be visible and used by other systems, make it 'active'

draftactiveinactive

Response

200404409422429

Updated

Body

application/json

createdAt*string (date-time)

iconnullable string

id*string (uuid)

name*string

parentFolderIdstring (uuid)

path*string

slug*string

status*enum

draftactiveinactive

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/content/folders/{contentPath}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404409422429

{
  "createdAt": "2024-11-21T08:50:53.756Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "updatedAt": "2024-11-21T08:50:53.756Z"
}