Flow Folders

List Flow Folders

get

Return a flat list of all folders for the tenant, ordered by position then name. The frontend assembles the folder tree from parent_id references.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get/api/v1/flow-folders

GET /api/v1/flow-folders HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Folder",
      "parent_id": null,
      "position": 0,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    }
  ]
}

Create Flow Folder

post

Create a new flow folder.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

namestring · max: 255Required

The folder name.

parent_idinteger · nullableOptional

The ID of the parent folder. Omit or set to null for a root-level folder.

positioninteger · nullableOptional

Display order position within the parent.

Responses

201

Folder created

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flow-folders

POST /api/v1/flow-folders HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "Integrations",
  "parent_id": null,
  "position": 0
}

{
  "data": {
    "id": 1,
    "name": "Integrations",
    "parent_id": null,
    "position": 0,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Update Flow Folder

put

Update an existing flow folder. All fields are optional — only provided fields are updated.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_folderintegerRequired

The unique identifier of the flow folder.

Body

namestring · max: 255Optional

The folder name.

parent_idinteger · nullableOptional

The ID of the parent folder. Set to null to move to the root level.

positioninteger · nullableOptional

Display order position within the parent.

Responses

200

Folder updated

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

404

Folder not found

422

Validation Error

application/json

put/api/v1/flow-folders/{flow_folder}

PUT /api/v1/flow-folders/{flow_folder} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "name": "Renamed Folder",
  "parent_id": 2,
  "position": 1
}

{
  "data": {
    "id": 1,
    "name": "Renamed Folder",
    "parent_id": 2,
    "position": 1,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Delete Flow Folder

delete

Delete a flow folder. If recursive is true, all descendant folders are also deleted and any flows inside them are detached (their folder assignment is cleared).

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_folderintegerRequired

The unique identifier of the flow folder.

Body

recursivebooleanOptional

If true, deletes all descendant folders and detaches their flows.

Responses

200

Folder deleted

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

404

Folder not found

delete/api/v1/flow-folders/{flow_folder}

DELETE /api/v1/flow-folders/{flow_folder} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "recursive": true
}

{
  "message": "Folder deleted successfully."
}