# Workato API Resources

# 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.

# 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.
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.

# 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_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 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.

# Lookup Tables

Type Resource Description
GET /api/lookup_tables Lists tables.
GET /api/lookup_tables/:lookup_table_id/lookup Lookup row
GET /api/lookup_tables/:lookup_table_id/rows List rows
POST /api/lookup_tables/:lookup_table_id/rows Add row
PUT /api/lookup_tables/:lookup_table_id/rows/:row_id Update row
DELETE /api/lookup_tables/:lookup_table_id/rows/:row_id Delete row
GET /api/lookup_tables/:lookup_table_id/rows/:row_id Get row