Workato Embedded partner APIs

Workato's Embedded partner platform APIs allow partners to control and even automate the provisioning of customer accounts and assets within them like recipes and connections.

All requests are authenticated by the credentials of the partner's admin account. To start using the APIs listed below, the user must have a Workato Embedded account. Please contact your Workato representative to learn more.

Authentication

All API requests must contain:

• X-USER-TOKEN and X-USER-EMAIL in the request headers OR
• user_token & user_email in the query parameters

For all Workato Embedded platform APIs, the token and email belong to the partner's main admin account.

The user_token/X-USER-TOKEN can be found in the settings page (opens new window). Alternatively, navigate to account settings by clicking on Account Settings in the dropdown of the top right of the homepage in Workato. The API key can be found in the left navigation panel in the subsequent page.

Supported Formats

Workato API supports sending the payload with the application/json content-type. All replies are also encoded in 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"}

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.

Manage 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

The endpoints listed below are Workato Embedded partner only endpoints for importing a package into a customer account.

The APIs for exporting a package are available here.

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.