Skip to main content
POST
/
api
/
v1
/
folders
Create folder
curl --request POST \
  --url https://api.getarca.app/api/v1/folders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "<string>",
  "name": "<string>",
  "icon": "<string>",
  "color": "<string>"
}
'
{
  "id": 15,
  "workspace_id": 3,
  "name": "Design",
  "icon": "folder-2",
  "color": "purple",
  "position": 3,
  "created_at": "2026-03-18T10:00:00.000Z"
}
Requires the folders:write scope. Viewers cannot create folders.

Request body

workspace_id
string
required
Numeric ID of the workspace to create the folder in.
name
string
required
Folder name. Leading and trailing whitespace is trimmed. HTML is sanitized.
icon
string
Optional icon identifier slug (e.g., "folder-1", "folder-2", "chart").
color
string
Optional color label. Defaults to "blue" if not provided.

Response

Returns the created folder. The position is automatically assigned as one greater than the current maximum position in the workspace.
id
number
required
New folder identifier.
workspace_id
number
required
Workspace this folder belongs to.
name
string
required
Folder name.
icon
string | null
Icon. null if not provided.
color
string | null
Color. Defaults to "blue".
position
number
required
Auto-assigned sort position.
created_at
string
required
UTC ISO-8601 creation timestamp.
{
  "id": 15,
  "workspace_id": 3,
  "name": "Design",
  "icon": "folder-2",
  "color": "purple",
  "position": 3,
  "created_at": "2026-03-18T10:00:00.000Z"
}