# Folders

Use the following endpoints to manage folders.

# Quick reference

Type Resource Description
GET /api/folders List folders.
GET /api/projects List projects.
POST /api/folders Create a folder.

# List folders

Lists all folders.

GET /api/folders

# URL Parameters

Name Type Description
parent_id string Parent folder ID. Defaults to Home folder.
page integer Page number. Defaults to 1.
per_page integer Page size. Defaults to 100 (maximum is 100).

# 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,
        "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,
        "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

# URL Parameters

Name Type Description
page integer Page number. Defaults to 1.
per_page integer Page size. Defaults to 100 (maximum is 100).

# 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 folder

Creates a new folder in the specified parent folder. If no parent folder ID is specified, the folder created will be a top level folder (in the Home folder).

POST /api/folders

# Payload

Name Type Description
name string
required
Name of the folder.
parent_id string Parent folder ID. Defaults to Home folder.

# 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,
}


Last updated: 10/18/2023, 7:14:53 PM