Folders ​

Use the following endpoints to manage folders and projects (top-level folders) in your workspace:

Rate limits ​

Folder resources have the following rate limits:

Quick reference ​

List folders ​

Lists all folders.

GET /api/folders

Query parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/folders?parent_id=12323' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response ​

[
    {
        "id": 7498,
        "name": "Netsuite production",
        "parent_id": 3319,
        "is_project": false,
        "project_id": 4567,
        "created_at": "2020-07-31T03:08:29.486-07:00",
        "updated_at": "2020-07-31T03:08:29.493-07:00"
    },
    {
        "id": 7302,
        "name": "Automation HR",
        "parent_id": 3319,
        "is_project": true,
        "project_id": null,
        "created_at": "2020-07-09T14:37:47.789-07:00",
        "updated_at": "2020-07-09T14:37:47.802-07:00"
    }
]

List projects ​

Lists all projects. Projects are top-level folders that normally encompass a single use case.

GET /api/projects

Query parameters ​

Sample request ​

curl  -X GET 'https://www.workato.com/api/projects' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response ​

[
    {
        "id": 649122,
        "description": "Coupa to Netsuite automations",
        "folder_id": 1563029,
        "name": "Procure to Pay"
    },
    {
        "id": 604202,
        "description": "Salesforce to Netsuite automations",
        "folder_id": 1486330,
        "name": "Order to Cash"
    },
]

Create a project or folder ​

Creates a new folder in the specified parent folder. If you do not specify a parent folder ID, the system creates the folder as a top-level folder in the home folder.

POST /api/folders

Payload ​

Sample request ​

curl  -X POST https://www.workato.com/api/folders \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Salesforce folder"
          }'

Response ​

{
  "id": 3498583,
}

Update a folder ​

Use this endpoint to update a folder name or move it to a different folder within your workspace. You can change the folder's name and update its parent_id if the folder is not a project. If the folder is a project, you can only change the project name using this endpoint.

Refer to the Update a project endpoint documentation for additional options in the request payload for projects.

PUT /api/folders/:folder_id

URL parameters ​

Payload ​

Sample request ​

curl  -X PUT https://www.workato.com/api/folders/12345 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "My updated folder name",
            "parent_id": 67890
          }'

Responses ​

{
    "id": 12345,
    "name": "My updated folder name",
    "parent_id": 67890,
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T14:26:30.365-07:00"
}

{
    "message": "Parent can't be changed for project folder"
}

{
    "message": "Folder name can't contain the folder path"
}

Update a project ​

Update a project in your workspace. Projects are top-level folders that typically encompass a single use case. Use this endpoint to change a project's name and description.

PUT /api/projects/:project_id

URL parameters ​

Payload ​

Sample request ​

curl  -X PUT https://www.workato.com/api/projects/54321 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "My updated project name",
            "description": "My updated project description"
          }'

Responses ​

{
    "id": 54321,
    "description": "My updated project description",
    "folder_id": 09876,
    "name": "My updated project name"
}

{
    "message": "Name is invalid"
}

Delete a folder ​

Delete a folder within your workspace.

To use this endpoint, your API client role must have the following privilege:

• Delete folder DELETE /api/folders/:id

DELETE /api/folders/:folder_id

URL parameters ​

Query parameters ​

Sample request ​

curl  -X DELETE 'https://www.workato.com/api/folders/12345?force=true' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
    "success": "true"
}

{
    "message": "can't remove a folder with connections"
}

{
    "message": "can't remove a folder with recipe"
}

Delete a project ​

Delete a project within your workspace. Projects are top-level folders that typically encompass a single use case.

To use this endpoint, your API client role must have the following privilege:

• Delete projects DELETE /api/projects/:id

DELETE /api/projects/:project_id

URL parameters ​

Sample request ​

curl  -X DELETE 'https://www.workato.com/api/projects/54321' \
      -H 'Authorization: Bearer <api_token>'

Response ​

{
    "success": "true"
}

{
    "message": "Cannot destroy folder"
}