POST /folder — create a new folder

Use this endpoint to create a new folder in your Bugsmash workspace. You can attach existing projects at creation time by passing their UUIDs, and optionally nest the folder under a parent by supplying a parentId. If you omit both optional fields, a standalone empty folder is created.

Endpoint

POST https://api.bugsmash.io/api/v2/folder

Request

Headers

string

required

Your Bugsmash API key.

string

required

Must be application/json.

Body parameters

string

required

Display name for the new folder.

string[]

List of project UUIDs to attach to the folder at creation. Pass an empty array to create the folder with no projects.

uuid

UUID of an existing folder to nest this folder under. Omit to create a top-level folder.

Example request

curl --location 'https://api.bugsmash.io/api/v2/folder' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "name": "New Folder",
  "projectIds": ["{projectId1}", "{projectId2}"]
}'

Response

{
  "status": true,
  "message": "Folder created",
  "data": {
    "name": "New Folder",
    "workspace_id": "c3d4e5f6-a7b8-9012-cdef-012345678902",
    "owner": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
    "share_access": "public",
    "created_by": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
    "parent_id": "e5f6a7b8-c9d0-1234-efab-234567890124",
    "id": "f6a7b8c9-d0e1-2345-fabc-345678901235",
    "updated_at": "2026-04-06T15:39:55.000000Z",
    "created_at": "2026-04-06T15:39:55.000000Z",
    "short_url": "https://app.bugsmash.io/review/KlMnO"
  }
}

Response fields

boolean

true when the folder was created successfully.

string

Human-readable status message.

object

The newly created folder object.

Show properties

string

UUID of the newly created folder.

string

Display name of the folder.

string

UUID of the workspace this folder belongs to.

string

UUID of the user who owns the folder.

Access level of the folder. Defaults to public on creation.

string

UUID of the user who created the folder.

string

UUID of the parent folder, if one was provided. null for top-level folders.

string

Shareable URL for the folder.

string

ISO 8601 timestamp of when the folder was created.

string

ISO 8601 timestamp of the most recent update to the folder.

Folders

Versions

Projects

Comments

Webhooks

POST /folder — create a new folder

Endpoint

Request

Headers

Body parameters

Example request

Response

Response fields

​Endpoint

​Request

​Headers

​Body parameters

​Example request

​Response

​Response fields

Endpoint

Request

Headers

Body parameters

Example request

Response

Response fields