# Folders
Use the following endpoint to manage folders in customer accounts.
# Quick reference
Type | Resource | Description |
---|---|---|
GET | /api/managed_users/:managed_user_id/folders | List folders. |
GET | /api/managed_users/:managed_user_id/projects | List projects. |
POST | /api/managed_users/:managed_user_id/folders | Create a folder. |
# List folders
Lists all folders in a customer account.
GET /api/managed_user_id/:managed_user_id/folders
# URL Parameters
Name | Type | Description |
---|---|---|
managed_user_id | string required | Workato Embedded customer Account ID/External ID. External ID must be prefixed with an E(eg: EA2300) and the resulting ID should be URL encoded. |
# Query 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/managed_users/1199/folders?parent_id=12323' \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \
# Response
{
"result": [
{
"id": 1789,
"name": "Netsuite production",
"parent_id": 4515,
"created_at": "2020-07-16T10:49:53.337-07:00",
"updated_at": "2020-07-16T10:49:53.347-07:00"
}
]
}
# List projects
Lists all projects. Projects are top level folders that normally encompass a single use case.
GET /api/managed_user_id/:managed_user_id/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/managed_user_id/:managed_user_id/projects' \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \
# Response
{
"result": [
{
"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 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/managed_users/:managed_user_id/folders
# URL Parameters
Name | Type | Description |
---|---|---|
managed_user_id | string required | Workato Embedded customer Account ID/External ID. External ID must be prefixed with an E(eg: EA2300) and the resulting ID should be URL encoded. |
# 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/managed_users/1892/folders \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Salesforce folder"
}'
# Response
{
"id": 3498583,
}
Last updated: 6/15/2023, 10:05:14 PM