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.
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.
POST	/api/api_clients	Create an API client.
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	Update an access profile belonging to an API client.
PUT	/api_access_profiles	Enable an access profile belonging to an API client.
PUT	/api_access_profiles	Disable an access profile belonging to an API client.
PUT	/api/api_access_profiles/:id/refresh_secret	Refreshes access profile key or secret.

---

Connections

Type	Resource	Description
GET	/api/connections	List connections belonging to user.

---

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

---

Environment properties

Type	Resource	Description
GET	/api/properties	Lists environment properties that matches a prefix.
POST	/api/properties	Upserts environment 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.

---

Folders

Type	Resource	Description
GET	/api/folders	List folders.
GET	/api/projects	List projects.
POST	/api/folders	Create a folder.
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.

---

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.

---

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?environment_type=:environment_type	Deploys a project build to an environment. Use the Build a project endpoint to build the project first.
POST	/api/projects/:id/deploy?environment_type=:environment_type	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. Query parameters may be used to filter results to a specific project, folder, date range, etc.

---

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.

---

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.

---

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.

---

Roles

Type	Resource	Description
GET	/api/roles	List custom roles.
POST	/api/roles/:role_id/copy	Makes a copy of a custom role.

---

Secrets management

Type	Resource	Description
POST	/api/secrets_management/clear_cache	Clears the secrets management cache.

---

Team collaborators

Type	Resource	Description
POST	/api/member_invitations	Invites a collaborator to your team.

---

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.

---

Users

Type	Resource	Description
GET	/api/users/me	Get details of authenticated user.
GET	/api/members	Get a list of members in your workspace.
GET	/api/members/:id	Get details about a user you specify.
GET	/api/members/:id/privileges	Get the role and privileges for a workspace user you specify.

---