Create a folder

Create a new folder for documents or templates.

type selects which entity the folder organizes. Pass parentFolderId to nest under an existing folder.

POST /api/v1/folders

Create a folder

cURL

curl --request POST \
  --url https://app.sajn.se/api/v1/folders \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "name": "<string>",
  "parentFolderId": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "parentFolderId": "<string>",
  "workspaceId": "<string>",
  "createdById": "<string>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "childFolderCount": 0,
  "itemCount": 0
}

Headers

authorization · string · required

Bearer token for API authentication

Body

application/json

Body

name · string · required

Folder name

Minimum string length: 1

type · enum<string> · required

Folder type: DOCUMENT or TEMPLATE

Available options: DOCUMENT, TEMPLATE

parentFolderId · string | null

Parent folder to nest under. Omit for a top-level folder.

Response

200

application/json

200

id · string · required

Unique folder identifier

name · string · required

Folder name

type · enum<string> · required

Folder type: DOCUMENT or TEMPLATE

Available options: DOCUMENT, TEMPLATE

parentFolderId · string | null · required

Parent folder id, or null for top-level folders

workspaceId · string · required

createdById · string · required

createdAt · any · required

updatedAt · any · required

childFolderCount · integer

Number of direct child folders (non-deleted)

Required range: -9007199254740991 <= x <= 9007199254740991

itemCount · integer

Number of documents or templates directly in this folder

Required range: -9007199254740991 <= x <= 9007199254740991