# Workato Embedded Partner APIs
WHO CAN USE THIS FEATURE?
A Workato Embedded account is required to use Workato Embedded Partner APIs. Contact your Workato representative for more info.
Workato's Embedded Partner Platform APIs allow partners to programmatically create and manage customer accounts and assets, such as recipes and connections.
# Authentication
To authenticate to the API, use the API key and email in the partner's main admin account.
To retrieve your credentials, navigate to the Settings > API key (opens new window) page in your account.
You can authenticate using request headers or query parameters.
# Authentication Using Request Headers
To authenticate using request headers, include X-USER-TOKEN and X-USER-EMAIL and your API key and email, respectively:
curl -X GET 'https://www.workato.com/api/managed_users/19029/properties?prefix=salesforce_sync.' \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>' \
-H 'Content-Type: application/json' \
# Authentication Using Query Parameters
To authenticate using query parameters, include user_token and user_email and your API key and email, respectively:
curl -X GET 'https://www.workato.com/api/managed_users/19029/connections?user_email=<EMAIL_ADDRESS>&user_token=<TOKEN>'
# Supported Formats
Requests sent to the API should include Content-type: application/json in the header:
curl -X GET 'https://www.workato.com/api/managed_users/19029/properties?prefix=salesforce_sync.' \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>' \
-H 'Content-Type: application/json' \
Responses are encoded using application/json; charset=utf-8.
# HTTP Response Codes
| Name | Description | Sample reply |
|---|---|---|
200 | Success | {"Success": true} |
400 | Bad request | {"message": "Bad request"} |
401 | Unauthorized | {"message": "Unauthorized"} |
404 | Not found | {"message": "Not found"} |
500 | Server error | {"message":"Server error","id":"3188c2d0-29a4-4080-908e-582e7ed82580"} |
# Resources
- Connectors
- Connections
- Picklists
- Folders
- Customer Accounts
- Recipes
- Recipe lifecycle management
- API platform
- Roles
- Account properties
- Lookup tables
# Connectors
| Type | Resource | Description |
|---|---|---|
| GET | /api/integrations | Query connector metadata. |
# Connections
| Type | Resource | Description |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/connections | Returns a list of connections in a customer account. |
| POST | /api/managed_users/:id/connections | Allows the Workato Embedded vendor to add a shell connection in a customer account. |
| PUT | /api/managed_users/:id/connections/:connection_id | Updates a connection in a customer account. |
# Picklists
| Type | Resource | Description |
|---|---|---|
| POST | /managed_users/:id/connections/:connection_id/pick_list | Obtains a list of picklist values for a specified connection in a Workato Embedded customer account. |
# Folders
| Type | Resource | Description |
|---|---|---|
| GET | /api/managed_users/:id/folders | List folders in a customer account. |
| POST | /api/managed_users/:id/folders | Creates a new folder in a customer account. |
# Customer Accounts
| Type | Resource | Description |
|---|---|---|
| POST | /api/managed_users | Create customer account. |
| PUT | /api/managed_users | Update customer account. |
| DELETE | /api/managed_users | Delete customer account. |
| GET | /api/managed_users/:id | Get customer account. |
| GET | /api/managed_users/ | Get a list of all customer accounts. |
| GET | /api/managed_users/members | Get a list of all members in a customer account. |
| GET | /api/managed_users/members/:member_id | Get a member in a customer account. |
| POST | /api/managed_users/:id/members | Add member to customer account. |
| PUT | /api/managed_users/members/:member_id | Update a member in a customer account. |
| DELETE | /api/managed_users/:id/members/:member_id | Remove member from customer account. |
| GET | /api/managed_users/:id/connections | List customer connections. |
| GET | /api/managed_users/usage | Get task usage of all customer accounts by month. |
# Recipes
| Type | Resource | Description |
|---|---|---|
| GET | /api/managed_users/:id/recipes | List recipes belonging to a customer account. |
| GET | /api/managed_users/:id/recipes/:recipe_id | Get details of a recipe belonging to a customer account. |
| GET | /api/recipes/search | Search for public recipes. |
| POST | /api/managed_users/:managed_user_id/recipes | Create a recipe in a customer account. |
| PUT | /api/managed_users/:managed_user_id/recipes/:id | Update a recipe in a customer account. |
| DELETE | /api/managed_users/:id/recipes/:recipe_id | Delete a recipe in a customer account. |
| PUT | /api/managed_users/:managed_user_id/recipes/:recipe_id/start | Start a recipe in a customer account. |
| PUT | /api/managed_users/:managed_user_id/recipes/:recipe_id/stop | Stop a recipe in a customer account. |
# Recipe Lifecycle Management
WHO CAN USE THESE ENDPOINTS?
The endpoints in this guide are Embedded Partner APIs. Contact your Workato representative for more info.
Looking for APIs to export packages? Refer to the Workato API docs.
| Type | Resource | Description |
|---|---|---|
| POST | /api/managed_users/:id/imports | Import package into a folder in a customer account. |
| GET | /api/managed_users/:id/recipes | Get status of an imported package. |
# API Platform
| Type | Resource | Description |
|---|---|---|
| GET | /api/api_collections | List API collections in a customer account. |
| POST | /api/api_collections | Create API collection in a customer account. |
| GET | /api/api_endpoints | List API endpoints in a collection. |
| PUT | /api/api_endpoints/:id/enable | Enable an API endpoint in a collection. |
| PUT | /api/api_endpoints/:id/disable | Disable an API endpoint in a collection. |
| GET | /api/api_clients | List API clients in a customer account. |
| POST | /api/api_clients | Create API client in a customer account. |
| GET | /api/api_access_profiles | List access profiles belonging to an API client in a customer account. |
| POST | /api/api_access_profiles | Create an access profile belonging to an API client in a customer account. |
| PUT | /api/api_access_profiles | Update an access profile belonging to an API client in a customer account. |
| PUT | /api/api_access_profiles/:api_access_profile_id/enable | Enable an access profile belonging to an API client in a customer account. |
| PUT | /api/api_access_profiles | Disable an access profile belonging to an API client in a customer account. |
| PUT | /api/api_access_profiles/:id/refresh_secret | Refreshes access profile token or secret. |
# Roles
| Type | Resource | Description |
|---|---|---|
| GET | /api/managed_users/:id/roles | List custom roles in a customer account. |
| POST | /api/managed_users/:id/roles/:role_id/copy | Makes a copy of a custom role. |
# Account Properties
| Type | Resource | Description |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/properties | Returns a list of account properties belonging to a customer account that matches a prefix. |
| POST | /api/managed_users/:managed_user_id/properties | Upserts account properties to a customer account. |
# Lookup Tables
| Type | Resource | Description |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/lookup_tables | Lists tables. |
| GET | /api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/lookup | Lookup row |
| GET | /api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows | List rows |
| POST | /api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows | Add row |
| PUT | /api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_id | Update row |
| DELETE | /api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_id | Delete row |
| GET | /api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_id | Get row |