# 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 enable partners to programmatically create and manage customer accounts and assets, including recipes and connections.


# Base URL

The Workato Embedded Partner APIs are a collection of endpoints for interacting with customer accounts, recipes, and more. Each endpoint contains the base URL and the resource path to the object.

The base URL of the endpoint depends on the data center (opens new window) you use. Here are the base URLs for each of Workato's data centers:

US Data Center
https://www.workato.com/api/
EU Data Center
https://app.eu.workato.com/api/
JP Data Center
https://app.jp.workato.com/api/
SG Data Center
https://app.sg.workato.com/api/

# Authentication

To authenticate to the API, create an API Client under Workspace Access. Learn more.

# Provide API tokens as a bearer token

Provide your API client's API token in the request headers as a bearer token.

curl -X GET 'https://www.workato.com/api/managed_users/19029/properties' \
      -H 'Authorization: Bearer <api_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 'Authorization: Bearer <api_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

Type Resource Description
GET /api/integrations Query connector metadata.
GET /api/integrations/all Returns a paginated list of all connectors and associated metadata in an Embedded partner's account. The response includes standard and custom connectors.

# Custom Connectors

Type Resource Description
GET /api/custom_connectors Get custom connectors.
GET /api/custom_connectors/:id Get custom connector by ID
POST /api/custom_connectors/:id/oem_share/:version Create or update a shared connector
POST api/managed_users/:managed_user_id/recipes/:recipe_id/share Share a recipe containing a custom connector with Embedded partners.
DELETE /api/custom_connectors/:id/suppress_oem_version Remove a shared connector

# 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.
POST api/managed_users/:managed_user_id/exports/:manifest_id Export package based on the manifest ID. Requires the oem_vendor privilege.
GET api//managed_users/:managed_user_id/exports/:package_id Returns the status of a package export. Requires the oem_vendor privilege.

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

# Environment Properties

Type Resource Description
GET /api/managed_users/:managed_user_id/properties Returns a list of environment properties belonging to a customer account that matches a prefix.
POST /api/managed_users/:managed_user_id/properties Upserts environment 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