Skip to main content
POST
Create a folder

Authorizations

scribe_session
string
cookie
required

Browser session cookie set by the WorkOS sign-in flow.

Body

application/json

Name, scope, and optional parent of the new folder.

Create a folder.

name
string
required

Name of the new folder.

Required string length: 1 - 200
Example:

"Specs"

scope
enum<string>
required

Section to create the folder in.

Available options:
workspace,
private
Example:

"workspace"

parentId
string

Parent folder id. Omit to create at the root of the section.

Example:

"fld_7qRsTuVwXyZaBcDeFg3h"

Response

The created folder.

A folder in the workspace or private sidebar section.

id
string
required

Folder id.

Example:

"fld_7qRsTuVwXyZaBcDeFg3h"

name
string
required

Folder name.

Example:

"Specs"

scope
enum<string>
required

Section the folder lives in: the shared workspace or the owner's private area.

Available options:
workspace,
private
Example:

"workspace"

parentId
string | null
required

Parent folder id, or null at the root of its section.

Example:

null

ownerUserId
string | null
required

Owner of a private folder; null for workspace folders.

Example:

null

createdAt
integer
required

When the folder was created (epoch milliseconds).

Example:

1752624000000

updatedAt
integer
required

When the folder was last renamed or moved (epoch milliseconds).

Example:

1752624000000