Workato API Resources
Agent Studio
| Type | Resource | Description |
|---|---|---|
| GET | /api/agentic/genies | Returns a list of genies. |
| POST | /api/agentic/genies | Creates a new genie. |
| PUT | /api/agentic/genies/:id | Updates an existing genie. |
| GET | /api/agentic/genies/:id | Returns the genie associated with the ID you specify. |
| DELETE | /api/agentic/genies/:id | Deletes a genie. |
| POST | /api/agentic/genies/:id/start | Starts the genie associated with the ID you specify. |
| POST | /api/agentic/genies/:id/stop | Stops the genie associated with the ID you specify. |
| POST | /api/agentic/genies/:id/assign_skills | Assigns skills to the genie associated with the ID you specify. |
| POST | /api/agentic/genies/:id/remove_skills | Removes skills from the genie associated with the ID you specify. |
| POST | /api/agentic/genies/:id/assign_knowledge_bases | Assigns knowledge bases to the genie associated with the ID you specify. |
| POST | /api/agentic/genies/:id/remove_knowledge_bases | Removes knowledge bases from the genie associated with the ID you specify. |
| POST | /api/agentic/genies/:id/assign_user_groups | Assigns user group access to the genie associated with the ID you specify. |
| POST | /api/agentic/genies/:id/remove_user_groups | Removes user group access from the genie associated with the ID you specify. |
| GET | /api/agentic/knowledge_bases | Returns a list of knowledge bases. |
| POST | /api/agentic/knowledge_bases | Creates a new knowledge base. |
| GET | /api/agentic/knowledge_bases/:id | Returns the knowledge base associated with the ID you specify. |
| PUT | /api/agentic/knowledge_bases/:id | Updates an existing knowledge base. |
| DELETE | /api/agentic/knowledge_bases/:id | Deletes a knowledge base. |
| GET | /api/agentic/knowledge_bases/:id/data_sources | Returns the data sources associated with the knowledge base ID you specify. |
| GET | /api/agentic/knowledge_bases/:id/recipes | Returns the recipes associated with the knowledge base ID you specify. |
| GET | /api/agentic/skills | Returns a list of skills. |
| POST | /api/agentic/skills | Creates a new skill. |
| GET | /api/agentic/skills/:id | Returns the skill associated with the ID you specify. |
API clients
| Type | Resource | Description |
|---|---|---|
| GET | /api/developer_api_clients | List Developer API Clients. |
| POST | /api/developer_api_clients | Create a Developer API Client. |
| GET | /api/developer_api_clients/:id | Get a Developer API Client by ID. |
| PUT | /api/developer_api_clients/:id | Update a Developer API Clients. |
| DELETE | /api/developer_api_clients/:id | Delete a Developer API Client. |
| POST | /api/developer_api_clients/:id/regenerate | Regenerate a Developer API Client token. |
| GET | /api/developer_api_client_roles | List Developer API Client roles. |
API platform
| Type | Resource | Description |
|---|---|---|
| GET | /api/api_collections | List API collections. |
| POST | /api/api_collections | Create an API collection. |
| 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. We recommend that you migrate to the List API clients (v2) endpoint to prepare for future deprecation. |
| GET | /api/v2/api_clients | List all API clients. Workato includes the project_id of the project associated with the API client in the response. |
| POST | /api/api_clients | Create an API client. We recommend that you migrate to the Create API client (v2) endpoint to prepare for future deprecation. |
| POST | /api/v2/api_clients | Create a new API client within a project you specify. |
| GET | /api/v2/api_clients/:api_client_id | Retrieve details of an API client by ID. |
| PUT | /api/v2/api_clients/:api_client_id | Update an existing API client within a project you specify. |
| DELETE | /api/v2/api_clients/:api_client_id | Delete an existing API client. |
| GET | /api/api_access_profiles | List access profiles belonging to an API client. We recommend that you migrate to the List API keys endpoint to prepare for future deprecation. |
| GET | /api/v2/api_clients/:api_client_id/api_keys | List API keys for an API client. |
| POST | /api/api_access_profiles | Create an access profile belonging to an API client. We recommend that you migrate to the Create API key endpoint to prepare for future deprecation. |
| POST | /api/v2/api_clients/:api_client_id/api_keys | Create an API key for an API client. |
| PUT | /api/api_access_profiles | Update an access profile belonging to an API client. We recommend that you migrate to the Update API key endpoint to prepare for future deprecation. |
| PUT | /api/v2/api_clients/:api_client_id/ api_keys/:api_key_id | Update an API key for an API client. |
| PUT | /api_access_profiles | Enable an access profile belonging to an API client. We recommend that you migrate to the Enable API key endpoint to prepare for future deprecation. |
| PUT | /api/v2/api_clients/:api_client_id/ api_keys/:api_key_id/enable | Enable an API key for an API client. |
| PUT | /api_access_profiles | Disable an access profile belonging to an API client. We recommend that you migrate to the Disable API key endpoint to prepare for future deprecation. |
| PUT | /api/v2/api_clients/:api_client_id/ api_keys/:api_key_id/disable | Disable an API key for an API client. |
| PUT | /api/api_access_profiles/:id/refresh_secret | Refreshes access profile key or secret. We recommend that you migrate to the Refresh API key secret endpoint to prepare for future deprecation. |
| PUT | /api/v2/api_clients/:api_client_id/ api_keys/:api_key_id/refresh_secret | Refresh the authentication token or OAuth 2.0 client secret for an API key. |
| DELETE | /api/v2/api_clients/:api_client_id/ api_keys/:api_key_id | Delete an existing API key. |
| GET | /api/v2/api_portals | List all API portals associated with API clients in your workspace. |
Collaborator groups
| Type | Resource | Description |
|---|---|---|
| GET | /api/user_groups | List collaborator groups. |
| GET | /api/user_groups/:id | Get collaborator group details. |
| POST | /api/user_groups | Create a collaborator group. |
| PUT | /api/user_groups/:id | Update a collaborator group. |
| DELETE | /api/user_groups/:id | Delete a collaborator group. |
| GET | /api/user_groups/:id/members | List collaborator group members. |
| POST | /api/user_groups/:id/members | Add members to a collaborator group. |
| DELETE | /api/user_groups/:id/members | Remove members from a collaborator group. |
| GET | /api/user_groups/:id/project_grants | List a collaborator group's project grants. |
Connections
| Type | Resource | Description |
|---|---|---|
| GET | /api/connections | Returns all connections and associated data. |
| POST | /api/connections | Create a connection. |
| PUT | /api/connections/:connection_id | Updates a connection. |
| POST | /api/connections/:connection_id/disconnect | Disconnects a connection. |
| DELETE | /api/connections/:connection_id | Deletes a connection. |
Connectors
| Type | Resource | Description |
|---|---|---|
| GET | /api/integrations | Returns a list of connectors and metadata specified in request. |
| GET | /api/integrations/all | Returns a paginated list of all connectors and associated metadata in a non-embedded workspace. The response includes standard and platform connectors. |
Custom connectors
| Type | Resource | Description |
|---|---|---|
| GET | /api/custom_connectors | Get custom connectors. |
| POST | /api/sdk/generate_schema/json | Generates Workato schema from a stringified JSON sample. |
| POST | /api/sdk/generate_schema/csv | Generates Workato schema from a stringified CSV sample. |
Custom OAuth profiles
| Type | Resource | Description |
|---|---|---|
| GET | /api/custom_oauth_profiles | List Custom OAuth profiles |
| GET | /api/custom_oauth_profiles/:id | Get Custom OAuth profile by ID |
| POST | /api/custom_oauth_profiles | Create Custom OAuth profile |
| PUT | /api/custom_oauth_profiles/:id | Update Custom OAuth profile |
| DELETE | /api/custom_oauth_profiles/:id | Delete Custom OAuth profile |
Data tables
Table management APIs
Base URL: https://www.workato.com
| Type | Resource | Description |
|---|---|---|
| GET | /api/data_tables | List all data tables. |
| GET | /api/data_tables/:data_table_id | Get data table by ID. |
| POST | /api/data_tables | Creates a data table. |
| PUT | /api/data_tables/:data_table_id | Updates a data table. |
| DELETE | /api/data_tables/:data_table_id | Deletes a data table. |
| POST | /api/data_tables/:data_table_id/truncate | Truncates a data table. |
Record manipulation APIs
Base URL: https://data-tables.workato.com
| Type | Resource | Description |
|---|---|---|
| POST | /api/v1/tables/:data_table_id/query | Queries records using filters you specify. |
| POST | /api/v1/tables/:data_table_id/records | Creates a new record. |
| PUT | /api/v1/tables/:data_table_id/records/:record_id | Updates an existing record. |
| DELETE | /api/v1/tables/:data_table_id/records/:record_id | Deletes a record you specify. |
| POST | /api/v1/tables/:data_table_id/fields/:field_id/file | Generates a link to upload a file. |
| GET | /api/v1/tables/:data_table_id/records/:record_id/fields/:field_id/file | Generates a link to download a file. |
Environment management
| Type | Resource | Description |
|---|---|---|
| POST | /api/secrets_management/clear_cache | Clears the secrets management cache. |
| GET | /api/activity_logs | Retrieves activity audit log records. |
| GET | /api/tags | Retrieves a list of tags. |
| POST | /api/tags | Creates a tag. |
| PUT | /api/tags/:handle | Updates a tag. |
| DELETE | /api/tags/:handle | Deletes a tag. |
Environment properties
| Type | Resource | Description |
|---|---|---|
| GET | /api/properties | Lists environment properties that matches a prefix. |
| POST | /api/properties | Upserts environment properties. |
Environment roles
| Type | Resource | Description |
|---|---|---|
| GET | /api/environment_roles | List environment roles. |
| GET | /api/environment_roles/:id | Get environment role details. |
| POST | /api/environment_roles | Create an environment role. |
| PUT | /api/environment_roles/:id | Update an environment role. |
| DELETE | /api/environment_roles/:id | Delete an environment role. |
Event streams
Public APIs
| Type | Resource | Description |
|---|---|---|
| POST | event-streams.workato.com/api/v1/topics/:topic_id/consume | Consume messages from a topic. |
| POST | event-streams.workato.com/api/v1/topics/:topic_id/publish | Publish a message to a topic. |
| POST | event-streams.workato.com/api/v1/batch/topics/:topic_id/publish | Publish a batch of messages to a topic. |
Developer APIs
| Type | Resource | Description |
|---|---|---|
| GET | /api/event_streams/topics | Retrieve a list of topics. |
| POST | /api/event_streams/topics | Create a topic. |
| GET | /api/event_streams/topics/:topic_id | Get topic by ID. |
| PUT | /api/event_streams/topics/:topic_id | Update a topic. |
| PUT | /api/event_streams/topics/:topic_id/purge | Purge a topic. |
| DELETE | /api/event_streams/topics/:topic_id | Delete a topic. |
Folders
| Type | Resource | Description |
|---|---|---|
| GET | /api/folders | List folders. |
| GET | /api/projects | List projects. |
| POST | /api/folders | Create a project or folder. |
| PUT | /api/folders/:folder_id | Update a folder. |
| PUT | /api/projects/:project_id | Update a project. |
| DELETE | /api/folders/:folder_id | Delete a folder. |
| DELETE | /api/projects/:project_id | Delete a project. |
Jobs
| Type | Resource | Description |
|---|---|---|
| GET | /api/recipes/:recipe_id/jobs | List jobs belonging to recipe. |
| GET | /api/recipes/:recipe_id/jobs/:job_handle | Returns a single job's metadata. |
| POST | /api/job/resume | Resumes a particular job based on the resume_token you provide. This endpoint returns HTTP status code 204, indicating successful request processing without any content included in the response. This endpoint is leveraged by SDK Wait for resume actions. |
| POST | /api/recipes/:recipe_id/repeat_jobs | Repeats jobs you specify. |
Legacy roles
| Type | Resource | Description |
|---|---|---|
| GET | /api/roles | List custom roles. |
| PUT | /api/roles/:role_id | Updates a custom role's project privileges. |
| POST | /api/roles/:role_id/copy | Makes a copy of a custom role. |
Lookup tables
| Type | Resource | Description |
|---|---|---|
| GET | /api/lookup_tables | List tables. |
| GET | /api/lookup_tables/:lookup_table_id/lookup | Look up a row |
| GET | /api/lookup_tables/:lookup_table_id/rows | List rows. |
| GET | /api/lookup_tables/:lookup_table_id/rows/:row_id | Get a row. |
| POST | /api/lookup_tables/:lookup_table_id/rows | Add a row. |
| POST | /api/lookup_tables | Create a new lookup table. |
| POST | /api/lookup_tables/batch_delete | Delete lookup tables in batch. |
| PUT | /api/lookup_tables/:lookup_table_id/rows/:row_id | Update a row. |
| DELETE | /api/lookup_tables/:lookup_table_id/rows/:row_id | Delete a row. |
MCP servers
Projects
| Type | Resource | Description |
|---|---|---|
| POST | /api/projects/:id/build | Builds a project. Use the Deploy a project build endpoint to deploy the project to an environment. |
| GET | /api/project_builds/:id | Retrieves a project build by its unique ID. |
| POST | /api/project_builds/:id/deploy | Deploys a project build to an environment. Use the Build a project endpoint to build the project first. |
| POST | /api/projects/:id/deploy | Builds and deploys a project to an environment. |
| GET | /api/deployments/:id | Retrieves a single deployment by its unique ID. |
| GET | /api/deployments | Retrieves a list of deployments. Use query parameters to filter results by project, folder, or date range. |
| GET | /api/deployments/:id/eligible_reviewers | Retrieves a list of eligible reviewers that can be assigned to review a deployment. |
| POST | /api/deployments/:id/assign_reviewers | Assigns reviewers to a deployment. |
| POST | /api/deployments/:id/submit_for_review | Submits a deployment for review. |
| POST | /api/deployments/:id/approve | Approves a deployment. |
| POST | /api/deployments/:id/reject | Rejects a deployment. |
| POST | /api/deployments/:id/reopen | Re-opens a deployment for review. |
| POST | /api/deployments/:id/update_review_comment | Updates a deployment review comment. |
| POST | /api/deployments/:id/deploy | Deploys an approved deployment. |
Project grants
| Type | Resource | Description |
|---|---|---|
| GET | /api/project_grants/:id | Get a project grant. |
| PUT | /api/project_grants/:id | Update a project grant. |
| DELETE | /api/project_grants/:id | Delete a project grant. |
| GET | /api/projects/:id/project_grants | List project grants by project ID. |
| PUT | /api/projects/:id/project_grants | Add or update project grants. |
Project properties
| Type | Resource | Description |
|---|---|---|
| GET | /api/properties | List project-level properties that match a prefix and project ID. |
| POST | /api/properties | Upsert project-level properties. |
Project roles
| Type | Resource | Description |
|---|---|---|
| GET | /api/project_roles | List project roles. |
| GET | /api/project_roles/:id | Get project role details. |
| POST | /api/project_roles | Create a project role. |
| PUT | /api/project_roles/:id | Update a project role. |
| DELETE | /api/project_roles/:id | Delete a project role. |
Recipes
| Type | Resource | Description |
|---|---|---|
| GET | /api/recipes/:id | Get recipe details. |
| POST | /api/recipes | Create recipe. |
| POST | /api/recipes | Copy recipe. |
| PUT | /api/recipes/:id | Update recipe. |
| GET | /api/recipes | List recipes belonging to user. |
| PUT | /api/recipes/:id/start | Start recipe. |
| PUT | /api/recipes/:id/stop | Stop recipe. |
| DELETE | /api/recipes/:id | Delete recipe. |
| POST | /api/recipes/:recipe_id/reset_trigger | Reset recipe trigger. |
| PUT | /api/recipes/:recipe_id/connect | Update connection for an application in a stopped recipe. |
| POST | /api/recipes/:recipe_id/poll_now | Activate a polling trigger for a recipe. |
| GET | /api/recipes/:recipe_id/versions | Get recipe versions. |
| GET | /api/recipes/:recipe_id/versions/:id | Get details of a recipe version. |
| PATCH/PUT | /api/recipes/:recipe_id/versions/:id | Update a recipe version comment. |
| GET | /api/recipes/:recipe_id/health | Retrieve the most recent optimization report for a recipe. |
| POST | /api/recipes/:recipe_id/health | Queue a performance scan using Performance Copilot. |
Recipe Lifecycle Management
| Type | Resource | Description |
|---|---|---|
| GET | /api/export_manifests/folder_assets | View assets in a folder. |
| POST | api/export_manifests | Create an export manifest. |
| PUT | api/export_manifests/:id | Update an export manifest. |
| GET | api/export_manifests/:id | View an export manifest. |
| DELETE | /api/export_manifests/:id | Delete an export manifest. |
| POST | /api/packages/export/:manifest_id | Export package based on a manifest. |
| POST | /api/packages/import/:folder_id | Import a package into a folder. |
| GET | /api/packages/:id | Get a package by its ID. |
| GET | /api/packages/:id/download | Download a package. |
Role migration
| Type | Resource | Description |
|---|---|---|
| POST | /api/roles_migration/system_roles | Migrate system roles. |
| POST | /api/roles_migration/custom_role | Migrate a custom role. |
Tag assignments
| Type | Resource | Description |
|---|---|---|
| POST | /api/tags_assignments | Apply tags to or remove tags from assets in your workspace. |
Test Automation
| Type | Resource | Description |
|---|---|---|
| POST | /api/test_cases/run_requests | Run test cases. |
| GET | /api/test_cases/run_requests/{id} | Get the current state of a test case run request. |
| GET | /api/recipes/{recipe_id}/test_cases | Get test cases. |
Workspace collaborators
| Type | Resource | Description |
|---|---|---|
| POST | /api/member_invitations | Invite a collaborator to a workspace. |
| GET | /api/members | Get list of collaborators. |
| GET | /api/members/:id | Get collaborator details. |
| PUT | /api/members/:id | Update collaborator roles. |
| DELETE | /api/members/:id | Delete a collaborator. |
| GET | /api/members/:id/project_grants | List a collaborator's project grants. |
| GET | /api/members/:id/privileges | Get collaborator privileges. |
| GET | /api/members/:id/projects_privileges | Get collaborator project privileges. |
Workspace details
Get details
| Type | Resource | Description |
|---|---|---|
| GET | /api/users/me | Get details about your workspace. |
Workato Identity IAM
| Type | Resource | Description |
|---|---|---|
| GET | /api/iam/users | List users in the workspace. |
| GET | /api/iam/users/:user-id | Retrieve details for a specific user by ID. |
| POST | /api/iam/users | Create one or more new users. |
| PUT | /api/iam/users/:user-id | Update an existing user. |
| DELETE | /api/iam/users/:user-id | Delete a user from the workspace. |
| POST | /api/iam/users/:user-id/add_to_group | Add a user to a specific group. |
| POST | /api/iam/users/:user-id/remove_from_group | Remove a user from a specific group. |
| GET | /api/iam/user_groups | List user groups in the current environment. |
| GET | /api/iam/user_groups/:user-group-id | Retrieve details for a specific user group by ID. |
| POST | /api/iam/user_groups | Create a new user group. |
| PUT | /api/iam/user_groups/:user-group-id | Update an existing user group. |
| DELETE | /api/iam/user_groups/:user-group-id | Delete a user group. |
| POST | /api/iam/user_groups/:user-group-id/add_users | Add multiple users to a group. |
| DELETE | /api/iam/user_groups/:user-group-id/remove_users | Remove multiple users from a group. |
| GET | /api/iam/user_groups/:user-group-id/members | List all members of a user group. |
| GET | /api/iam/app_links | List app links in the current environment. |
| POST | /api/iam/app_links | Create an app link. |
| DELETE | /api/iam/app_links/:id | Delete an app link by ID. |
| DELETE | /api/iam/app_links | Delete app links by IDs. |
Last updated: