Workato API Resources
API clients
| Type | Resource | Description |
|---|---|---|
| GET | /api/developer_api_clients | List Developer API clients |
| POST | /api/developer_api_clients | Create a Developer API client |
| DELETE | /api/resources/api-clients/:id | Delete a Developer API client |
| GET | /api/resources/api-clients/:id | Get a Developer API client by ID |
| PUT | /api/resources/api-clients/:id | Update a Developer API client |
| POST | /api/resources/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 |
| PUT | /api/api_endpoints /:api_endpoint_id/disable | Disable an API endpoint |
| PUT | /api/api_endpoints /:api_endpoint_id/enable | Enable an API endpoint |
| GET | /api/api_clients | List API clients |
| GET | /api/v2/api_clients | List API clients (v2) |
| POST | /api/api_clients | Create an API client |
| POST | /api/v2/api_clients | Create an API client (v2) |
| GET | /api/v2/api_clients /:api_client_id | Retrieves details of an API client by its unique ID. |
| GET | /api/api_access_profiles | List access profiles belonging to an API client |
| POST | /api/api_access_profiles | Create an access profile belonging to an API client |
| PUT | /api/api_access_profiles /:api_access_profile_id | Update an access profile belonging to an API client |
| PUT | /api/api_access_profiles /:api_access_profile_id/disable | Disable an access profile |
| PUT | /api/api_access_profiles /:api_access_profile_id/enable | Enable an access profile |
| PUT | /api/api_access_profiles /:api_access_profile_id /refresh_secret | Refresh token secret or oauth client secret |
| GET | /api/v2/api_clients /api_client_id/api_keys | Retrieves all API keys for an API client. |
| POST | /api/v2/api_clients /api_client_id/api_keys | Creates a new API key for an API client. |
| PUT | /api/v2/api_clients /api_client_id/api_keys /api_key_id | Updates an existing API key for an API client. |
| PUT | /api/v2/api_clients /api_client_id/api_keys /api_key_id/enable | Enables an API key for an API client, allowing it to make authenticated requests. |
| PUT | /api/v2/api_clients /api_client_id /api_keys/api_key_id/disable | Disables an API key for an API client, preventing it from making API requests. |
| PUT | /api/v2/api_clients /api_client_id/api_keys /api_key_id/refresh_secret | Refreshes the authentication token or OAuth 2.0 client secret for an API key. |
| GET | /api/v2/api_portals | Retrieves a list of all API portals associated with API clients in your workspace. |
| GET | /api/cert_bundles | List all certificate bundles. |
| POST | /api/cert_bundles | Create a new certificate bundle. |
| PUT | /api/cert_bundles /:certificate_bundle_id | Update a certificate bundle. |
| DELETE | /api/cert_bundles /:certificate_bundle_id | Delete a certificate bundle. |
| GET | /api/cert_bundles /certificate_bundle_id/download | Download the certificate bundle PEM file. |
Connections
| Type | Resource | Description |
|---|---|---|
| GET | /api/connections | List connections belonging to user |
| POST | /api/connections | Creates a new connection |
| DELETE | /api/connections/:id | Delete a Connection |
| PUT | /api/connections/:id | Update a connection |
| POST | /api/connections /:id/disconnect | Disconnect a Connection |
Connectors
| Type | Resource | Description |
|---|---|---|
| GET | /api/integrations | List connector metadata. |
| GET | /api/integrations/all | List all platform connectors. |
Custom connectors
| Type | Resource | Description |
|---|---|---|
| POST | /api/sdk/generate_schema/csv | Generate schema from CSV |
| POST | /api/sdk/generate_schema/json | Generate schema from JSON |
| POST | /api/custom_connectors | Create custom connector |
| GET | /api/custom_connectors/search | Search custom connector belonging to user by title |
| PUT | /api/custom_connectors/:id | Update custom connector |
| GET | /api/custom_connectors/:id/code | Get custom connectors code |
| POST | /api/custom_connectors/:id/release | Release custom connector |
| POST | /api/custom_connectors/:id/share | Share custom connector |
Custom OAuth profiles
| Type | Resource | Description |
|---|---|---|
| GET | /api/custom_oauth_profiles | List Custom OAuth profiles |
| POST | /api/custom_oauth_profiles | Create a Custom OAuth profile |
| DELETE | /api/custom_oauth_profiles/:id | Delete a custom OAuth profile |
| GET | /api/custom_oauth_profiles/:id | Get Custom OAuth profile by ID |
| PUT | /api/custom_oauth_profiles/:id | Update a Custom OAuth profile |
Data tables
| 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 you specify. |
| DELETE | /api/data_tables/:data_table_id | Deletes a data table you specify. |
| POST | /api/data_tables /:data_table_id/truncate | Truncates a data table you specify. Truncating a data table deletes all data from a data table, but leaves the table structure intact. |
Environment management
| Type | Resource | Description |
|---|---|---|
| POST | /api/secrets_management/clear_cache | Clear secrets management cache. |
| GET | /api/activity_logs | Get activity audit log. |
| GET | /api/tags | Retrieves activity audit log records. |
| POST | /api/tags | Creates a tag. |
| PUT | /api/tags/:handle | Updates a tag. |
| DELETE | /api/tags/:handle | Deletes a tag. |
Environment and project properties
| Type | Resource | Description |
|---|---|---|
| GET | /api/properties | List properties by prefix |
| POST | /api/properties | Upserts properties |
Event streams
| 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. |
| 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. |
Event streams public API
| Type | Resource | Description |
|---|---|---|
| POST | /api/v1/topics/:topic_id/consume | Retrieve messages from the topic. |
| POST | /api/v1/topics/:topic_id/publish | Publish a message to a topic. The message must comply with the topic schema. |
| POST | /api/v1/batch/topics/:topic_id/publish | Publish a batch of messages to a topic. The messages must comply with the topic schema. |
Folders
| Type | Resource | Description |
|---|---|---|
| GET | /api/folders | List folders |
| POST | /api/folders | Create a folder |
| DELETE | /api/folders/:folder_id | Delete a folder |
| PUT | /api/folders/:id | Update a folder |
| GET | /api/projects | List projects in your workspace. |
| PUT | /api/projects/:project_id | Update a project in your workspace. |
| DELETE | /api/projects /:project_id | Delete a project within your workspace. |
Jobs
| Type | Resource | Description |
|---|---|---|
| GET | /api/recipes/:recipe_id/jobs | List jobs from a 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. |
Lookup tables
| Type | Resource | Description |
|---|---|---|
| GET | /api/lookup_tables | List lookup tables |
| POST | /api/lookup_tables | Create a new lookup table |
| POST | /api/lookup_tables /batch_delete | Delete lookup tables in batch |
| GET | /api/lookup_tables /:lookup_table_id /lookup | Lookup a row |
| GET | /api/lookup_tables /:lookup_table_id/rows | List rows |
| POST | /api/lookup_tables /:lookup_table_id /rows | Add a row |
| DELETE | /api/lookup_tables /:lookup_table_id /rows/:row_id | Delete a row |
| GET | /api/lookup_tables /:lookup_table_id /rows/:row_id | Get a row |
| PUT | /api/lookup_tables /:lookup_table_id /rows/:row_id | Update a row |
On-prem
| Type | Resource | Description |
|---|---|---|
| GET | /api/on_prem_agents | List On-prem agents |
| POST | /api/on_prem_agents | Create On-prem agent |
| GET | /api/on_prem_agents /search | Search for On-prem agent by common name |
| DELETE | /api/on_prem_agents /:id | Delete On-prem agent |
| GET | /api/on_prem_agents /:id/activation_code | Get on-prem agent activation code. |
| GET | /api/on_prem_agents/:id | Get On-prem agent details |
| PUT | /api/on_prem_agents/:id | Update On-prem agent |
| GET | /api/on_prem_agents /:id/status | Get On-prem agent status |
| GET | /api/on_prem_groups | List On-prem groups |
| POST | /api/on_prem_groups | Create On-prem group |
| DELETE | /api/on_prem_groups /:id | Delete On-prem group |
| GET | /api/on_prem_groups /:id | Get On-prem group details |
| PUT | /api/on_prem_groups/:id | Update On-prem group |
| GET | /api/on_prem_groups /:id/status | Get On-prem group status |
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. |
| 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. |
Recipes
| Type | Resource | Description |
|---|---|---|
| GET | /api/recipes | List recipes belonging to a user. |
| POST | /api/recipes | Create a recipe |
| DELETE | /api/recipes/:recipe_id | Delete a recipe |
| GET | /api/recipes/:recipe_id | Get recipe details |
| PUT | /api/recipes/:recipe_id | Update a recipe |
| PUT | /api/recipes /:recipe_id/connect | Update a connection for a recipe |
| POST | /api/recipes /:recipe_id/copy | Copy a recipe |
| POST | /api/recipes /:recipe_id/poll_now | Forces a running recipe to poll immediately |
| POST | /api/recipes /:recipe_id/reset_trigger | Reset recipe trigger |
| PUT | /api/recipes /:recipe_id/start | Start a recipe |
| PUT | /api/recipesv /:recipe_id/stop | Stop a recipe |
| GET | /api/recipes /:recipe_id/versions | List versions of a recipe |
| GET | /api/recipes /:recipe_id/versions/:id | Get version details |
| PUT | /api/recipes /:recipe_id/versions/:id | Update a version |
| 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 |
|---|---|---|
| POST | /api/export_manifests | Create an export manifest |
| GET | /api/export_manifests /folder_assets | view content of the folder |
| DELETE | /api/export_manifests/:id | Delete an export manifest |
| GET | /api/export_manifests/:id | View an export manifest |
| PUT | /api/export_manifests/:id | Update an export manifest |
| POST | /api/packages/export /:manifest_id | Export package based on the manifest. |
| POST | /api/packages/import /:folder_id | Import a package into the folder |
| GET | /api/packages/:id | Get package |
| GET | /api/packages/:id /download | Download the package |
Roles
| Type | Resource | Description |
|---|---|---|
| GET | /api/roles | List custom roles belonging to user. |
| PUT | /api/roles/:id | Update a custom role. |
| POST | /api/roles /:id/copy | Copy a custom role. |
Tag assignments
| Type | Resource | Description |
|---|---|---|
| POST | /api/tags_assignments | Apply or remove asset tags in your workspace. |
Test Automation
| Type | Resource | Description |
|---|---|---|
| GET | /api/recipes /:recipe_id/test_cases | List test cases for a recipe |
| POST | /api/test_cases /run_requests | Create a test case run request |
| GET | /api/test_cases /run_requests/:id | Get the current state of a test case run request |
Workspace collaborators
| Type | Resource | Description |
|---|---|---|
| GET | /api/members | Get list of workspace collaborators |
| GET | /api/members/:id | Get collaborator details |
| PUT | /api/members/:id | Update collaborator roles |
| GET | /api/members/:id/privileges | Get collaborator privileges |
| POST | /api/member_invitations | Invite a collaborator |
| 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/privileges | Get collaborator privileges. |
| GET | /api/members/:id/projects_privileges | Get collaborator projects privileges. |
| 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. |
| 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. |
| 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. |
| 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. |
| PUT | /api/projects/:id/project_grants | Add grants to a project. |
| POST | /api/roles_migration/system_roles | Migrate system roles. |
| POST | /api/roles_migration/custom_role | Migrate a custom role. |
Workspace details
| Type | Resource | Description |
|---|---|---|
| GET | /api/users/me | Get authenticated user details |