Workato API

Workato's Platform API provides you with access to Workato resources. With this, you can manage recipes, connections and jobs programmatically to expand the functionality of your Workato account.

Authentication

All API requests must contain:

• X-USER-TOKEN and X-USER-EMAIL in the request headers OR
• user_token & user_email in the query parameters

The user_token/X-USER-TOKEN can be found in your settings page (opens new window). Alternatively, navigate to your account settings by clicking on Account Settings in the dropdown of the top right of your homepage in Workato. Your API key can be found in the left navigation panel in the subsequent page.

Supported Formats

Workato API supports sending request body with the application/json content-type. All replies are also encoded in 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"}

Connections

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

Jobs

Type	Resource	Description
GET	/api/recipes/:recipe_id/jobs	List jobs belonging to recipe.

Recipes

Type	Resource	Description
GET	/api/recipes/:id	Get recipe details.
POST	/api/recipes	Create 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.

User

Type	Resource	Description
GET	/api/users/me	Get details of authenticated user.

Recipe lifecycle management

Type	Resource	Description
POST	/api/packages/export/:manifest_id	Export package based on a manifest.
POST	/api/packages/import/:folder_id	Import package into a folder.
GET	/api/packages/:id	Get package by ID.
GET	/api/packages/:id/download	Download package.

API platform

Type	Resource	Description
GET	/api/api_collections	List API collections.
POST	/api/api_collections	Create 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 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/api_access_profiles/:id/refresh_secret	Refreshes access profile token or secret.

Roles

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

Account properties

Type	Resource	Description
GET	/api/properties	Lists account properties that matches a prefix.
POST	/api/properties	Upserts account properties.