Embedded API endpoints ​

Agent Studio ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/agentic/geniesReturns a list of genies.
POST/api/managed_users/:managed_user_id/agentic/geniesCreates a new genie.
PUT/api/managed_users/:managed_user_id/agentic/genies/:idUpdates an existing genie.
GET/api/managed_users/:managed_user_id/agentic/genies/:idReturns the genie associated with the ID you specify.
DELETE/api/managed_users/:managed_user_id/agentic/genies/:idDeletes a genie.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/startStarts the genie associated with the ID you specify.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/stopStops the genie associated with the ID you specify.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/assign_skillsAssigns skills and MCP servers to the genie associated with the ID you specify.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/remove_skillsRemoves skills from the genie associated with the ID you specify.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/assign_knowledge_basesAssigns knowledge bases to the genie associated with the ID you specify.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/remove_knowledge_basesRemoves knowledge bases from the genie associated with the ID you specify.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/assign_user_groupsAssigns user group access to the genie associated with the ID you specify.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/remove_user_groupsRemoves user group access from the genie associated with the ID you specify.
GET/api/managed_users/:managed_user_id/agentic/genies/clientsReturns a list of genie clients.
POST/api/managed_users/:managed_user_id/agentic/genies/clientsCreates a new genie client (API key or OAuth).
GET/api/managed_users/:managed_user_id/agentic/genies/clients/:client_idReturns the genie client associated with the ID you specify.
PUT/api/managed_users/:managed_user_id/agentic/genies/clients/:client_idUpdates a genie client's name and OAuth redirect URLs.
DELETE/api/managed_users/:managed_user_id/agentic/genies/clients/:client_idDeletes a genie client.
POST/api/managed_users/:managed_user_id/agentic/genies/clients/:client_id/regenerateRegenerates the API key for a genie client.
POST/api/managed_users/:managed_user_id/agentic/genies/clients/:client_id/pausePauses a genie client.
POST/api/managed_users/:managed_user_id/agentic/genies/clients/:client_id/startStarts a paused genie client.
POST/api/managed_users/:managed_user_id/agentic/genies/:id/clientsAttaches a client to a genie.
DELETE/api/managed_users/:managed_user_id/agentic/genies/:id/clients/:client_idDetaches a client from a genie.
GET/api/managed_users/:managed_user_id/agentic/genies/:genie_id/interfacesReturns all chat interface triggers of a genie in a single list.
GET/api/managed_users/:managed_user_id/agentic/genies/:genie_id/conversationsReturns a list of a genie's conversations. Doesn't include event-level detail.
GET/api/managed_users/:managed_user_id/agentic/genies/:genie_id/conversations/:conversation_idReturns a genie conversation you specify. Doesn't include event-level detail.
GET/api/managed_users/:managed_user_id/agentic/genies/:genie_id/conversations/:conversation_id/eventsReturns the full events of a single conversation.
GET/api/managed_users/:managed_user_id/agentic/genies/:genie_id/guardrailsReturns the guardrail and its policies for the genie associated with the ID you specify.
PUT/api/managed_users/:managed_user_id/agentic/genies/:genie_id/guardrails/policies/:policy_typeCreates or updates a single guardrail policy on the genie associated with the ID you specify.
GET/api/managed_users/:managed_user_id/agentic/knowledge_basesReturns a list of knowledge bases.
POST/api/managed_users/:managed_user_id/agentic/knowledge_basesCreates a new knowledge base.
GET/api/managed_users/:managed_user_id/agentic/knowledge_bases/:idReturns the knowledge base associated with the ID you specify.
PUT/api/managed_users/:managed_user_id/agentic/knowledge_bases/:idUpdates an existing knowledge base.
DELETE/api/managed_users/:managed_user_id/agentic/knowledge_bases/:idDeletes a knowledge base.
GET/api/managed_users/:managed_user_id/agentic/knowledge_bases/:id/data_sourcesReturns the data sources associated with the knowledge base ID you specify.
GET/api/managed_users/:managed_user_id/agentic/knowledge_bases/:id/recipesReturns the recipes associated with the knowledge base ID you specify.
GET/api/managed_users/:managed_user_id/agentic/skillsReturns a list of skills.
POST/api/managed_users/:managed_user_id/agentic/skillsCreates a new skill.
GET/api/managed_users/:managed_user_id/agentic/skills/:idReturns the skill associated with the ID you specify.

API clients ​

TypeResourceDescription
GET/api/v2/managed_users/:id/developer_api_clientsList all Developer API clients in a customer workspace.
POST/api/v2/managed_users/:id/developer_api_clientsCreate a new Developer API client in a customer workspace.
GET/api/v2/managed_users/:id/developer_api_clients/:idRetrieve details of a Developer API client by ID in a customer workspace.
PUT/api/v2/managed_users/:id/developer_api_clients/:idUpdate an existing Developer API client in a customer workspace.
DELETE/api/v2/managed_users/:id/developer_api_clients/:idDelete an existing Developer API client in a customer workspace.
POST/api/v2/managed_users/:id/developer_api_clients/:id/regenerateRegenerate the token for a Developer API client in a customer workspace.
GET/api/v2/managed_users/:managed_user_id/developer_api_client_rolesList Developer API client roles in a customer workspace.
POST/api/v2/managed_users/:managed_user_id/developer_api_client_roles/:id/copyCopy a Developer API client role in a customer workspace.

API platform ​

TypeResourceDescription
GET/api/managed_users/:id/api_collectionsList API collections in a customer workspace.
POST/api/managed_users/:id/api_collectionsCreate API collection in a customer workspace.
PUT/api/managed_users/:id/api_collections/:api_collection_idUpdate an existing API collection in a customer workspace.
DELETE/api/managed_users/:id/api_collections/:api_collection_idDelete an API collection along with its endpoints in a customer workspace.
GET/api/managed_users/:id/api_collections/:api_collection_id/openapiGet the OpenAPI specification for an API collection in a customer workspace.
GET/api/managed_users/:id/api_endpointsList API endpoints in a collection.
POST/api/managed_users/:id/api_collections/:api_collection_id/api_endpointsCreate an API endpoint within a collection in a customer workspace.
PUT/api/managed_users/:id/api_collections/:api_collection_id/api_endpoints/:api_endpoint_idUpdate an existing API endpoint in a customer workspace.
PUT/api/managed_users/:id/api_endpoints/:id/enableEnable an API endpoint in a collection.
PUT/api/managed_users/:id/api_endpoints/:id/disableDisable an API endpoint in a collection.
GET/api/managed_users/:id/api_endpoints/:id/openapiGet the OpenAPI specification for an API endpoint in a customer workspace.
GET/api/managed_users/:id/api_clientsList API clients in a customer workspace. We recommend that you migrate to the List API clients (v2) endpoint to prepare for future deprecation.
GET/api/v2/managed_users/:id/api_clientsList all API clients in a customer workspace. Workato includes the project_id of the project to which the API client belongs in the response.
POST/api/managed_users/:id/api_clientsCreate API client in a customer workspace. We recommend that you migrate to the Create API client (v2) endpoint to prepare for future deprecation.
POST/api/v2/managed_users/:id/api_clientsCreate a new API client in a customer workspace within a project you specify.
GET/api/v2/managed_users/:id/api_clients/:api_client_idRetrieve details of an API client by ID in a customer workspace.
PUT/api/v2/managed_users/:id/api_clients/:api_client_idUpdate an existing API client within a project you specify in a customer workspace.
DELETE/api/v2/managed_users/:id/api_clients/:api_client_idDelete an existing API client in a customer workspace.
GET/api/managed_users/:id/api_access_profilesList access profiles belonging to an API client in a customer workspace. We recommend that you migrate to the List API keys endpoint to prepare for future deprecation.
GET/api/v2/managed_users/:id/api_clients/:api_client_id/api_keysList API keys for an API client in a customer workspace.
POST/api/managed_users/:id/api_access_profilesCreate an access profile belonging to an API client in a customer workspace. We recommend that you migrate to the Create API key endpoint to prepare for future deprecation.
POST/api/v2/managed_users/:id/api_clients/:api_client_id/api_keysCreate an API key for an API client in a customer workspace.
PUT/api/managed_users/:id/api_access_profilesUpdate an access profile belonging to an API client in a customer workspace. We recommend that you migrate to the Update API key endpoint to prepare for future deprecation.
PUT/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_idUpdate an API key for an API client in a customer workspace.
PUT/api/managed_users/:id/api_access_profiles/:api_access_profile_id/enableEnable an access profile belonging to an API client in a customer workspace. We recommend that you migrate to the Enable API key endpoint to prepare for future deprecation.
PUT/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_id/enableEnable an API key for an API client in a customer workspace.
PUT/api/managed_users/:id/api_access_profilesDisable an access profile belonging to an API client in a customer workspace. We recommend that you migrate to the Disable API key endpoint to prepare for future deprecation.
PUT/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_id/disableDisable an API key for an API client in a customer workspace.
PUT/api/managed_users/:id/api_access_profiles/:id/refresh_secretRefreshes an access profile token or secret. We recommend that you migrate to the Refresh API key secret endpoint to prepare for future deprecation.
POST/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_id/refresh_secretRefresh the authentication token or OAuth 2.0 client secret for an API key in a customer workspace.
DELETE/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_idDelete an existing API key in a customer workspace.
GET/api/v2/managed_users/:id/api_portalsList all API portals associated with API clients in a customer workspace.
GET/api/managed_users/:id/cert_bundlesList all certificate bundles in a customer workspace.
POST/api/managed_users/:id/cert_bundlesCreate a new certificate bundle in a customer workspace.
PUT/api/managed_users/:id/cert_bundles/:idUpdate a certificate bundle in a customer workspace.
DELETE/api/managed_users/:id/cert_bundles/:idDelete a certificate bundle in a customer workspace.
GET/api/managed_users/:id/cert_bundles/:id/downloadDownload the certificate bundle PEM file in a customer workspace.

Collaborator groups ​

TypeResourceDescription
GET/api/v2/managed_users/:managed_user_id/user_groupsList customer workspace collaborator groups.
GET/api/v2/managed_users/:managed_user_id/user_groups/:idGet customer workspace collaborator group details.
POST/api/v2/managed_users/:managed_user_id/user_groupsCreate a customer workspace collaborator group.
PUT/api/v2/managed_users/:managed_user_id/user_groups/:idUpdate a customer workspace collaborator group.
DELETE/api/v2/managed_users/:managed_user_id/user_groups/:idDelete a customer workspace collaborator group.
GET/api/v2/managed_users/:managed_user_id/user_groups/:id/membersList collaborator group members in a customer workspace.
POST/api/v2/managed_users/:managed_user_id/user_groups/:id/membersAdd members to a customer workspace collaborator group.
DELETE/api/v2/managed_users/:managed_user_id/user_groups/:id/membersRemove members from a customer workspace collaborator group.
GET/api/v2/managed_users/:managed_user_id/user_groups/:id/project_grantsList a customer workspace collaborator group's project grants.

Connections ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/connections/:adapter_name/input_schemaReturns input schema based on a connection's input.
GET/api/managed_users/:managed_user_id/connectionsReturns a list of connections in a customer workspace.
POST/api/managed_users/:managed_user_id/connectionsAllows the Embedded vendor to add a shell connection in a customer workspace.
PUT/api/managed_users/:managed_user_id/connections/:connection_idUpdates a connection in a customer workspace.
POST/api/managed_users/:managed_user_id/connections/:connection_id/disconnectDisconnects a connection in a customer workspace.
DELETE/api/managed_users/:managed_user_id/connections/:connection_idDeletes a connection in a customer workspace.

Connectors ​

TypeResourceDescription
GET/api/v2/managed_users/:managed_user_id/connectors/:connector_name/input_schemaReturns the base input schema. The schemas are static and don't take specific connection input into consideration.
GET/api/integrationsQuery connector metadata.
GET/api/integrations/allReturns a paginated list of all connectors and associated metadata in an Embedded partner's account. The response includes standard and custom connectors.

Custom connectors ​

TypeResourceDescription
GET/api/custom_connectorsGet custom connectors.
GET/api/custom_connectors/:idGet custom connector by ID
POST/api/custom_connectors/:id/oem_share/:versionCreate or update a shared connector
POSTapi/managed_users/:managed_user_id/recipes/:recipe_id/shareShare a recipe containing a custom connector with Embedded partners.
DELETE/api/custom_connectors/:id/suppress_oem_versionRemove a shared connector

Custom OAuth profiles ​

TypeResourceDescription
POST/api/managed_users/:managed_user_id/custom_oauth_profiles/:id/assignAssign a Custom OAuth profile to customer workspace
DELETE/api/managed_users/:managed_user_id/custom_oauth_profiles/:id/unassignUnassigns a Custom OAuth profile to a customer workspace.

Customer managers ​

TypeResourceDescription
GET/api/customer_managersList all customer managers.
PUT/api/customer_managers/:idUpdate a customer manager.
POST/api/customer_managersCreate a new customer manager.
DELETE/api/customer_managers/:idDelete a customer manager.

Customer workspace collaborators ​

TypeResourceDescription
POST/api/managed_users/:id/member_invitationInvites a collaborator to a managed customer workspace.

Data retention ​

TypeResourceDescription
PUT/api/managed_users/:managed_user_id/update_data_retentionUpdate a customer workspace's data retention period.

Data tables ​

Table management APIs ​

Base URL: https://app.workato.com

TypeResourceDescription
GET/api/v2/managed_users/:managed_user_id/data_tablesList all data tables.
GET/api/v2/managed_users/:managed_user_id/data_tables/:data_table_idGet data table by ID.
POST/api/v2/managed_users/:managed_user_id/data_tablesCreates a data table.
PUT/api/v2/managed_users/:managed_user_id/data_tables/:data_table_idUpdates a data table.
DELETE/api/v2/managed_users/:managed_user_id/data_tables/:data_table_idDeletes a data table.
POST /api/v2/managed_users/:managed_user_id/data_tables/:data_table_id/truncateTruncates a data table.

Record manipulation APIs ​

Base URL: https://data-tables.workato.com

TypeResourceDescription
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/queryQueries records using filters you specify.
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/recordsCreates a new record.
PUT/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/:record_idUpdates an existing record.
DELETE/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/:record_idDeletes a record you specify.
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/fields/:field_id/fileGenerates a link to upload a file.
GET/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/:record_id/fields/:field_id/fileGenerates a link to download a file.

Record import APIs ​

Base URL: https://data-tables.workato.com, except Upload file, which posts to the signed URL returned by Create file upload link.

TypeResourceDescription
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/file/upload_linkCreates a link to upload a file.
POST/sharing/filesUploads the file to the signed link.
DELETE/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/fileDeletes the uploaded file.
GET/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/fileDescribes the uploaded file.
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/startStarts importing records from the uploaded file.
DELETE/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/importDismisses or cancels the import.

Dynamic field mapping ​

TypeResourceDescription
GET/api/v2/managed_users/:managed_user_id
/recipes/:recipe_id/field_map_introspections
List all field map introspections in a specific recipe.
GET/api/v2/managed_users/:managed_user_id
/recipes/:recipe_id/field_map_introspections/:id
List the field map introspections for a specific field map schema.
PUT/api/v2/managed_users/:managed_user_id
/recipes/:recipe_id/field_map_introspections/:id
Update field mapping for a specific field map schema.
POST/api/v2/managed_users/:managed_user_id
/recipes/:recipe_id/field_map_introspections/:id
/refresh_schema
Refresh a recipe’s schema to update field map introspections.
POST/api/v2/managed_users/:managed_user_id
/recipes/:recipe_id/field_map_introspections/:id/pick_list
Retrieve picklist values for specific fields within a field map introspection of a recipe.

Environment management ​

TypeResourceDescription
GET/api/managed_users/:id/activity_logsRetrieves activity audit log records in a customer workspace.
GET/api/v2/managed_users/:id/tagsRetrieves a list of tags in a customer workspace.
POST/api/v2/managed_users/:id/tagsCreates a tag in a customer workspace.
PUT/api/v2/managed_users/:id/tags/:handleUpdates a tag in a customer workspace.
DELETE/api/v2/managed_users/:id/tags/:handleDeletes a tag in a customer workspace.

Environment properties ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/propertiesReturns a list of environment properties belonging to a customer workspace that matches a prefix.
POST/api/managed_users/:managed_user_id/propertiesUpserts environment properties to a customer workspace.

Environment roles ​

TypeResourceDescription
GET/api/v2/managed_users/:managed_user_id/environment_rolesList environment roles in a customer workspace.
GET/api/v2/managed_users/:managed_user_id/environment_roles/:idGet an environment role from a customer workspace.
POST/api/v2/managed_users/:managed_user_id/environment_rolesCreate an environment role in a customer workspace.
PUT/api/v2/managed_users/:managed_user_id/environment_roles/:idUpdate an environment role in a customer workspace.
DELETE/api/v2/managed_users/:managed_user_id/environment_roles/:idDelete an environment role in a customer workspace.

Environments ​

TypeResourceDescription
POST/api/managed_users/:id/environmentsProvision Environments for an existing customer. Any existing assets in the customer workspace are placed in the Development environment after provisioning.
POST/api/v2/managed_users/:managed_user_id/environmentsProvision Environments V2 for an existing customer. Any existing assets in the customer workspace are placed in the Production environment after provisioning.
GET/api/v2/managed_users/environments_provision_tasks/:idGet the status of asynchronous environment provisioning.

Event streams ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/event_streams/topicsList topics in a customer workspace.
POST/api/managed_users/:managed_user_id/event_streams/topicsCreate a topic in a customer workspace.
GET/api/managed_users/:managed_user_id/event_streams/topics/:topic_idGet a topic by ID in a customer workspace.
PUT/api/managed_users/:managed_user_id/event_streams/topics/:topic_idUpdate a topic in a customer workspace.
PUT/api/managed_users/:managed_user_id/event_streams/topics/:topic_id/purgePurge a topic in a customer workspace.
DELETE/api/managed_users/:managed_user_id/event_streams/topics/:topic_idDelete a topic in a customer workspace.

Folders ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/foldersList folders in a customer workspace.
POST/api/managed_users/:managed_user_id/foldersCreate a folder in a customer workspace.
PUT/api/managed_users/:managed_user_id/folders/:folder_idUpdate a folder in a customer workspace.
DELETE/api/managed_users/:managed_user_id/folders/:folder_idDelete a folder in a customer workspace.

Jobs ​

TypeResourceDescription
GET/api/managed_users/:id/recipes/:recipe_id/jobsList jobs for a recipe.
GET/api/managed_users/:id/recipes/:recipe_id/jobs/:job_idGet job details.
POST/api/managed_users/:managed_user_id/job/resumeResumes a job based on the resume_token you provide. A successful request returns a 204 No Content status code with no response body. This endpoint is used by SDK Wait for resume actions.
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/repeat_jobsRepeats jobs you specify in a customer workspace.
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/cancel_jobsCancels ongoing jobs you specify in a customer workspace.
TypeResourceDescription
PUT/api/account/signature_verification_keyUpdate JWT signature verification key.

Legacy roles ​

TypeResourceDescription
GET/api/managed_users/:id/rolesList custom roles in a customer workspace.
POST/api/managed_users/:id/roles/:role_id/copyMakes a copy of a custom role.

Lookup tables ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/lookup_tablesList tables.
GET/api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/lookupLook up rows.
GET/api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rowsList rows.
GET/api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_idList rows in a lookup table.
POST/api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rowsAdd a row to a lookup table.
POST/api/managed_users/:managed_user_id/lookup_tablesCreate a new lookup table.
POST/api/managed_users/:managed_user_id/lookup_tables/batch_deleteDelete lookup tables in batch.
PUT/api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_idUpdate a row in a lookup table.
DELETE/api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_idDelete a row in a lookup table.

Manage customers ​

TypeResourceDescription
POST/api/managed_usersCreate a customer.
PUT/api/managed_users/:idUpdate a customer.
DELETE/api/managed_users/:idDelete a customer.
GET/api/managed_users/:idGet a customer.
GET/api/managed_usersList all customers.
GET/api/managed_users/:id/membersGet a list of collaborators in a customer workspace.
GET/api/managed_users/:id/members/:member_idGet customer workspace collaborator details.
POST/api/managed_users/:id/membersAdd collaborator to customer workspace.
PUT/api/managed_users/:id/members/:member_idUpdate a customer workspace collaborator.
DELETE/api/managed_users/:id/members/:member_idRemove collaborator from customer workspace.
GET/api/managed_users/:id/members/:member_id/project_grantsList a customer workspace collaborator's project grants.
GET/api/managed_users/:id/connectionsList connections in a customer workspace.
GET/api/managed_users/:id/members/:member_id/privilegesGet privileges from a customer workspace collaborator.
GET/api/managed_users/:managed_user_id/members/:id/projects_privilegesGet projects privileges from a customer workspace collaborator.
POST/api/v2/managed_users/statistics/usageRetrieve usage metrics for customer workspaces with enhanced data granularity.
POST/api/v2/managed_users/statistics/connection_usageRetrieve connection-based usage metrics for specified customer workspaces.
GET/api/managed_users/usageGet task usage of all customers by month.
POST/api/managed_users/:id/environmentsProvision Environments for an existing customer.
GET/api/v2/managed_users/customer_categoriesList customer categories in an Embedded partner's workspace.
POST/api/v2/managed_users/customer_categoriesCreate a customer category.
PUT/api/v2/managed_users/customer_categories/:idUpdate a customer category.
DELETE/api/v2/managed_users/customer_categories/:idDelete a customer category.
POST/api/v2/managed_users/customer_categories/:id/assignBatch assign a customer category to workspaces.
POST/api/v2/managed_users/customer_categories/:id/unassignBatch unassign a customer category from workspaces.

MCP servers ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/mcp_serversList MCP servers in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_serversCreate an MCP server in a customer workspace.
GET/api/managed_users/:managed_user_id/mcp_servers/:handleRetrieve MCP server details in a customer workspace.
PUT/api/managed_users/:managed_user_id/mcp_servers/:handleUpdate an MCP server in a customer workspace.
DELETE/api/managed_users/:managed_user_id</br/>mcp_servers/:handleDelete an MCP server in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/token_renewRenew an MCP server authentication token in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tokensCreate a hashed token in a customer workspace.
DELETE/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tokens/:idDelete a hashed token in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tokens/:id/refreshRefresh a hashed token in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/assign_toolsAssign tools to an MCP server in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/assign_user_groupsAssign user groups to an MCP server in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/remove_user_groupsRemove user groups from an MCP server in a customer workspace.
PUT/api/managed_users/:managed_user_id/mcp_servers/:handle/update_folderMove an MCP server to a different folder in a customer workspace.
GET/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/server_policiesRetrieve the server policy configuration in a customer workspace.
PUT/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/server_policiesUpdate the server policy configuration in a customer workspace.
GET/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/toolsList tools for an MCP server in a customer workspace.
PUT/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tools/:idUpdate the tool description in a customer workspace.
DELETE/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tools/:idDelete a tool in a customer workspace.
GET/api/managed_users/:managed_user_id/user_groupsList identity provider user groups in a customer workspace.
GET/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/access_assignmentsList MCP access assignments in a customer workspace.
POST/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/access_assignmentsCreate an MCP access assignment in a customer workspace.
GET/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/access_assignments/:idRetrieve an MCP access assignment in a customer workspace.
PUT/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/access_assignments/:idUpdate an MCP access assignment in a customer workspace.
DELETE/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/access_assignments/:idDelete an MCP access assignment in a customer workspace.

On-prem ​

TypeResourceDescription
GET/api/v2/managed_users/:id/on_prem_groupsList on-prem groups in a customer workspace.
GET/api/v2/managed_users/:id/on_prem_agentsList on-prem agents in a customer workspace.
GET/api/v2/managed_users/:id/on_prem_agents/:agent_idRetrieve the details of a specific on-prem agent in a customer workspace using its ID.

Picklists ​

TypeResourceDescription
POST/api/managed_users/:id/connections/:connection_id/pick_listObtains a list of picklist values for a specified connection in an Embedded customer workspace.

Project grants ​

TypeResourceDescription
GET/api/v2/managed_users/:managed_user_id/project_grants/:idGet a customer workspace project grant.
PUT/api/v2/managed_users/:managed_user_id/project_grants/:idUpdate a customer workspace project grant.
DELETE/api/v2/managed_users/:managed_user_id/project_grants/:idDelete a customer workspace project grant.
GET/api/v2/managed_users/:managed_user_id/projects/:id/project_grantsList grants from a specific project in a customer workspace.
PUT/api/v2/managed_users/:managed_user_id/projects/:id/project_grantsAdd or update customer workspace project grants.

Project roles ​

TypeResourceDescription
GET/api/v2/managed_users/:managed_user_id/project_rolesList project roles in a customer workspace.
GET/api/v2/managed_users/:managed_user_id/project_roles/:idGet a project role from a customer workspace.
POST/api/v2/managed_users/:managed_user_id/project_rolesCreate a project role in a customer workspace.
PUT/api/v2/managed_users/:managed_user_id/project_roles/:idUpdate a project role in a customer workspace.
DELETE/api/v2/managed_users/:managed_user_id/project_roles/:idDelete a project role from a customer workspace.

Projects ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/projectsList projects in a customer workspace.
POST/api/managed_users/:managed_user_id/foldersCreate a project in a customer workspace.
PUT/api/managed_users/:managed_user_id/projects/:project_idUpdate a project in a customer workspace.
DELETE/api/managed_users/:managed_user_id/projects/:project_idDelete a project in a customer workspace.
GET/api/managed_users/:managed_user_id/propertiesList project-level properties by prefix and project ID.
POST/api/managed_users/:managed_user_id/propertiesUpsert project-level properties.
GET/api/managed_users/:managed_user_id/deploymentsRetrieve a list of deployments in a customer workspace.
GET/api/managed_users/:managed_user_id/deployments/:idRetrieve a single deployment in a customer workspace.
GET/api/managed_users/:managed_user_id/api/project_builds/:idRetrieve a downloaded package in a customer workspace.
POST/api/managed_users/:managed_user_id/projects/:id/buildBuild a project in a customer workspace.
POST/api/managed_users/:managed_user_id/project_builds/:id/deployDeploy a downloaded package in a customer workspace.
POST/api/managed_users/:managed_user_id/projects/:project_id/deployDeploy a project in a customer workspace.
GET/api/managed_users/:managed_user_id/deployments/:id/eligible_reviewersRetrieve a list of eligible reviewers that can be assigned to review a deployment in a customer workspace.
POST/api/managed_users/:managed_user_id/deployments/:id/assign_reviewersAssign reviewers to a deployment in a customer workspace.
POST/api/managed_users/:managed_user_id/deployments/:id/submit_for_reviewSubmit a deployment for review in a customer workspace.
POST/api/managed_users/:managed_user_id/deployments/:id/deployDeploy an approved deployment in a customer workspace.

Recipes ​

TypeResourceDescription
GET/api/managed_users/:id/recipesList recipes belonging to a customer.
GET/api/managed_users/:id/recipes/:recipe_idGet details of a recipe belonging to a customer.
GET/api/managed_users/:managed_user_id/recipes/job_countsGet job counts for one or more recipes belonging to a customer.
POST/api/managed_users/:managed_user_id/recipesCreate a recipe in a customer workspace.
PUT/api/managed_users/:managed_user_id/recipes/:idUpdate a recipe in a customer workspace.
POST/api/managed_users/:id/recipes/:recipe_id/copyCopy a recipe in a customer workspace.
DELETE/api/managed_users/:id/recipes/:recipe_idDelete a recipe in a customer workspace.
PUT/api/managed_users/:managed_user_id/recipes/:recipe_id/startStart a recipe in a customer workspace.
PUT/api/managed_users/:managed_user_id/recipes/:recipe_id/stopStop a recipe in a customer workspace.
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/reset_triggerReset the trigger for a recipe in a customer workspace.
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/poll_nowStart a poll-now recipe.
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/force_runForce a recipe to run on demand in a customer workspace.
GET/api/v2/managed_users/:managed_user_id/recipes/:recipe_id/versionsGet versions of a recipe belonging to a customer.
GET/api/v2/managed_users/:managed_user_id/recipes/:recipe_id/versions/:idGet details of a recipe version belonging to a customer.
PATCH/PUT/api/v2/managed_users/:managed_user_id/recipes/:recipe_id/versions/:idUpdate a recipe version comment in a customer workspace.

Recipe lifecycle management ​

Looking for APIs to export packages? Refer to the Workato API docs.

WHO CAN USE THESE ENDPOINTS?

The endpoints in this guide are Embedded Partner APIs. Contact your Workato representative for more info.

TypeResourceDescription
GET/api/managed_users/:managed_user_id/export_manifests/folder_assetsView assets in a folder.
POST/api/managed_users/:managed_user_id/export_manifestsCreate an export manifest.
PUT/api/managed_users/:managed_user_id/export_manifests/:idUpdate an export manifest.
GET/api/managed_users/:managed_user_id/export_manifests/:idView an export manifest.
DELETE/api/managed_users/:managed_user_id/export_manifests/:idDelete an export manifest.
POST/api/managed_users/:managed_user_id/importsImport a package into a folder located in a customer workspace.
GET/api/managed_users/:managed_user_id/recipesGet status of an imported package.
POST/api/managed_users/:managed_user_id/exports/:manifest_idExport package based on the manifest ID. Requires an Embedded workspace.
GET/api/managed_users/:managed_user_id/exports/:package_idReturns the status of a package export. Requires an Embedded workspace.

Role migration ​

TypeResourceDescription
POST/api/v2/managed_users/:managed_user_id/roles_migration/system_rolesMigrate system roles from a customer workspace.
POST/api/v2/managed_users/:managed_user_id/roles_migration/custom_roleMigrate a custom role from a customer workspace.

Tag assignments ​

TypeResourceDescription
POST/api/v2/managed_users/:id/tags_assignmentsApply or remove asset tags in a customer workspace.

Test Automation ​

TypeResourceDescription
POST/api/managed_users/:managed_user_id/test_cases/run_requestsRun test cases in a customer workspace.
GET/api/managed_users/:managed_user_id/recipes/:recipe_id/test_casesList test cases for a specific recipe in a customer workspace.
GET/api/managed_users/:managed_user_id/test_cases/run_requests/:test_idGet the current state of a test case run request in a customer workspace.

Workspace details ​

Workato Identity IAM ​

TypeResourceDescription
GET/api/managed_users/:managed_user_id/iam/usersList users in the customer workspace.
GET/api/managed_users/:managed_user_id/iam/users/:user-idRetrieve details for a specific user by ID.
POST/api/managed_users/:managed_user_id/iam/usersCreate one or more new users.
PUT/api/managed_users/:managed_user_id/iam/users/:user-idUpdate an existing user.
DELETE/api/managed_users/:managed_user_id/iam/users/:user-idDelete a user from the customer workspace.
POST/api/managed_users/:managed_user_id/iam/users/:user-id/add_to_groupAdd a user to a specific group.
POST/api/managed_users/:managed_user_id/iam/users/:user-id/remove_from_groupRemove a user from a specific group.
GET/api/managed_users/:managed_user_id/iam/user_groupsList user groups in the customer workspace.
GET/api/managed_users/:managed_user_id/iam/user_groups/:user-group-idRetrieve details for a specific user group by ID.
POST/api/managed_users/:managed_user_id/iam/user_groupsCreate a new user group.
PUT/api/managed_users/:managed_user_id/iam/user_groups/:user-group-idUpdate an existing user group.
DELETE/api/managed_users/:managed_user_id/iam/user_groups/:user-group-idDelete a user group.
POST/api/managed_users/:managed_user_id/iam/user_groups/:user-group-id/add_usersAdd multiple users to a group.
DELETE/api/managed_users/:managed_user_id/iam/user_groups/:user-group-id/remove_usersRemove multiple users from a group.
GET/api/managed_users/:managed_user_id/iam/user_groups/:user-group-id/membersList all members of a user group.
GET/api/managed_users/:managed_user_id/iam/app_linksList app links in the customer workspace.
POST/api/managed_users/:managed_user_id/iam/app_linksCreate an app link.
DELETE/api/managed_users/:managed_user_id/iam/app_links/:idDelete an app link by ID.
DELETE/api/managed_users/:managed_user_id/iam/app_linksDelete app links by IDs.

Last updated: