Skip to main content
POST
Create a folder

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

authorization
string
required

Bearer token for API authentication

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

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

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