Workato CLI command reference ​

Command reference for the Workato Platform CLI tool.

workato ​

Root command for the Workato Platform CLI. Provides access to all Workato automation and integration management capabilities.

Usage ​

workato [GLOBAL_OPTIONS] <COMMAND> [COMMAND_OPTIONS]

Options ​

Result ​

Displays available commands and global options when run without arguments.

Examples ​

Show all available commands.

workato --help

Use a specific profile.

workato --profile production recipes list

workato init ​

Initialize the Workato CLI for a new project. Sets up authentication, selects region, and configures project workspace.

Usage ​

workato init [OPTIONS]

Options ​

Result ​

Creates configuration files, authenticates with the Workato API, and sets up project structure.

Examples ​

Interactive setup

workato init

Non-interactive setup with a specific region.

workato init --profile prod --region eu --api-token wrkprod-xxx --project-name 'Production Integration'

workato workspace ​

Display current workspace information, including active profile, project, and connection status.

Usage ​

workato workspace

Result ​

Shows current profile, project details, API endpoint, and authentication status.

Examples ​

Check current workspace.

workato workspace

workato pull ​

Pull latest assets from Workato workspace to local project directory. Synchronizes recipes, connections, and data tables.

Usage ​

workato pull [OPTIONS]

Options ​

Result ​

Downloads and updates local files with latest versions from Workato workspace.

Examples ​

Pull the latest changes.

workato pull

Force pull and overwrite local changes.

workato pull --force

workato push ​

Push local changes to Workato workspace. Uploads modified recipes, connections, and other assets.

Usage ​

workato push [OPTIONS]

Options ​

Result ​

Uploads local changes to Workato workspace and optionally restarts recipes.

Examples ​

Push changes with confirmation.

workato push

Force push and restart recipes.

workato push --force --restart-recipes

workato profiles list ​

List all configured authentication profiles with their regions and status.

Usage ​

workato profiles list

Result ​

Displays table of profiles showing name, region, API endpoint, and active status.

Examples ​

Show all profiles.

workato profiles list

workato profiles use ​

Switch to a different authentication profile for subsequent commands.

Usage ​

workato profiles use <PROFILE_NAME>

Input ​

Result ​

Sets the specified profile as active for future CLI operations.

Examples ​

Switch to production profile.

workato profiles use production

workato profiles status ​

Displays the current active profile and its configuration details.

Usage ​

workato profiles status

Options ​

Result ​

Shows the name of the active profile, associated workspace, and connection status.

Examples ​

Check which profile is currently active.

workato profiles status

View detailed profile configuration.

workato profiles status --verbose

Get profile status in JSON format for automation.

workato profiles status --json

workato profiles delete ​

Remove a profile from the CLI configuration.

Usage ​

workato profiles delete <PROFILE_NAME>

Input ​

Result ​

Removes the specified profile and its associated configuration.

Examples ​

Delete development profile.

workato profiles delete development

workato projects list ​

List all available projects in the current Workato workspace.

Usage ​

workato projects list

Result ​

Displays table of projects with ID, name, description, and folder count.

Examples ​

Show all projects.

workato projects list

workato projects use ​

Switch to a different project context for CLI operations.

Usage ​

workato projects use <PROJECT_NAME>

Input ​

Result ​

Changes active project context and updates local workspace.

Examples ​

Switch to customer integration project.

workato projects use 'Customer Integration'

workato recipes list ​

List recipes in the workspace with filtering and pagination options.

Usage ​

workato recipes list [OPTIONS]

Options ​

Result ​

Displays table of recipes with ID, name, status, folder, and last activity.

Examples ​

List all recipes

workato recipes list

Show running recipes in specific folder

workato recipes list --folder-id 123 --running

Find recipes using Salesforce

workato recipes list --adapter-names-any salesforce

workato recipes validate ​

Validate recipe JSON file syntax and structure against Workato schema requirements.

Usage ​

workato recipes validate --path <FILE_PATH>

Options ​

Result ​

Reports validation results including syntax errors, missing fields, and schema violations.

Examples ​

Validate recipe file.

workato recipes validate --path ./my_recipe.recipe.json

workato recipes start ​

Start a stopped recipe by ID or name, enabling it to process triggers and execute actions.

Usage ​

workato recipes start [OPTIONS]

Options ​

Result ​

Starts the specified recipe and reports the new running status.

Examples ​

Start recipe by ID.

workato recipes start --id 12345

Start recipe by name.

workato recipes start --name 'Daily Sales Report'

workato recipes stop ​

Stop a running recipe, preventing it from processing new triggers while completing current jobs.

Usage ​

workato recipes stop [OPTIONS]

Options ​

Result ​

Stops the specified recipe and reports the new stopped status.

Examples ​

Stop recipe by ID.

workato recipes stop --id 12345

Stop recipe by name in specific folder.

workato recipes stop --name 'Data Sync' --folder-id 456

workato recipes update-connection ​

Updates the connection used by a specific connector in a stopped recipe.

Usage ​

workato recipes update-connection RECIPE_ID [OPTIONS]

Input ​

Options ​

Result ​

The recipe's connection for the specified adapter is updated to use the new connection. The recipe must be stopped before you can perform this operation.

Examples ​

Update a Salesforce connection in a recipe.

workato recipes update-connection 12345 --adapter-name salesforce --connection-id 67890

Switch Slack connection for a notification recipe.

workato recipes update-connection 54321 -a slack -c 98765

workato connections list ​

List all connections in the workspace with filtering options for provider, folder, and external ID.

Usage ​

workato connections list [OPTIONS]

Options ​

Result ​

Displays table of connections with ID, name, provider, status, and folder information.

Examples ​

List all connections.

workato connections list

Show Salesforce connections.

workato connections list --provider salesforce

List connections in specific folder.

workato connections list --folder-id 789

workato connections create ​

Create a new connection for a specific application provider with authentication details.

Usage ​

workato connections create [OPTIONS]

Options ​

Result ​

Creates new connection and returns connection ID and authentication status.

Examples ​

Create Salesforce connection.

workato connections create --name 'Prod SF' --provider salesforce

Create connection with parameters.

workato connections create --name 'JIRA Prod' --provider jira --input '{"server_url":"https://company.atlassian.net"}'

workato connections create-oauth ​

Create OAuth-based connection by opening browser for user authentication flow.

Usage ​

workato connections create-oauth [OPTIONS]

Options ​

Result ​

Opens browser for OAuth flow and creates authenticated connection upon completion.

Examples ​

Create OAuth connection.

workato connections create-oauth --name 'Google Drive OAuth' --provider google_drive

workato connections get-oauth-url ​

Generates the OAuth authorization URL for establishing a new connection.

Usage ​

workato connections get-oauth-url CONNECTION_ID [OPTIONS]

Input ​

Options ​

Result ​

Returns the OAuth authorization URL that users must visit to grant permissions and authenticate the connection.

Examples ​

Get OAuth URL for a new Salesforce connection.

workato connections get-oauth-url 12345

Generate OAuth URL with custom redirect.

workato connections get-oauth-url 12345 --redirect-url https://example.com/callback

workato connections update ​

Update existing connection properties such as name or configuration parameters.

Usage ​

workato connections update [OPTIONS]

Options ​

Result ​

Updates connection properties and returns confirmation of changes.

Examples ​

Update connection name.

workato connections update --connection-id 123 --name 'Updated Connection Name'

workato connections pick-list ​

Retrieve dynamic pick list values from a connection for use in recipe configuration.

Usage ​

workato connections pick-list [OPTIONS]

Options ​

Result ​

Returns available pick list options that can be used in recipe field mappings.

Examples ​

Get Salesforce objects.

workato connections pick-list --connection-id 123 --object-name sobjects

workato connectors list ​

List all available connectors in the Workato platform, including both standard and custom connectors.

Usage ​

workato connectors list [OPTIONS]

Options ​

Result ​

Displays table of connectors with name, provider ID, authentication type, and availability.

Examples ​

List all connectors.

workato connectors list

Show only custom connectors.

workato connectors list --custom

workato connectors parameters ​

Show connection parameters and authentication requirements for specific connectors.

Usage ​

workato connectors parameters [OPTIONS]

Options ​

Result ​

Displays connection fields, authentication methods, and configuration options.

Examples ​

Show Salesforce connection parameters.

workato connectors parameters --provider salesforce

Find OAuth connectors.

workato connectors parameters --oauth-only

workato data-tables list ​

List all data tables in the current workspace with schema and record count information.

Usage ​

workato data-tables list

Result ​

Displays table of data tables with ID, name, schema fields, and record counts.

Examples ​

Show all data tables.

workato data-tables list

workato data-tables create ​

Create a new data table with specified schema for storing structured data in recipes.

Usage ​

workato data-tables create [OPTIONS]

Options ​

Result ​

Creates new data table and returns table ID and schema confirmation.

Examples ​

Create simple data table.

workato data-tables create --name 'Customer Data'

Create table with schema.

workato data-tables create --name 'Products' --schema-json '[{"name":"product_id","type":"string","optional":false}]'

workato properties list ​

List environment or project properties that can be used in recipes for configuration management.

Usage ​

workato properties list [OPTIONS]

Options ​

Result ​

Displays properties with names, values (masked for sensitive data), and scope.

Examples ​

List all properties.

workato properties list

Show Salesforce-related properties.

workato properties list --prefix salesforce_

workato properties upsert ​

Create or update properties for environment or project-level configuration.

Usage ​

workato properties upsert [OPTIONS]

Options ​

Result ​

Creates or updates properties and confirms changes made.

Examples ​

Update property from file

workato properties upsert --project-id 123 --file properties.json

Set single property

workato properties upsert --key-value api_endpoint=https://api.example.com

workato api-collections list ​

List API collections that expose recipes as REST endpoints for external consumption.

Usage ​

workato api-collections list [OPTIONS]

Options ​

Result ​

Displays API collections with ID, name, project, and endpoint count.

Examples ​

List all API collections.

workato api-collections list

workato api-collections create ​

Create a new API collection to group and manage recipe endpoints.

Usage ​

workato api-collections create [OPTIONS]

Options ​

Result ​

Creates new API collection and returns collection ID and configuration details.

Examples ​

Create API collection.

workato api-collections create --name 'Customer API'

workato api-collections list-endpoints ​

List all API endpoints within a specific collection showing their status and configuration.

Usage ​

workato api-collections list-endpoints [OPTIONS]

Options ​

Result ​

Displays endpoints with ID, name, HTTP method, path, and enabled status.

Examples ​

Show endpoints in collection.

workato api-collections list-endpoints --api-collection-id 456

workato api-collections enable-endpoint ​

Enable a specific API endpoint to make it available for external API calls.

Usage ​

workato api-collections enable-endpoint [OPTIONS]

Options ​

Result ​

Enables the endpoint and provides the public URL for API access.

Examples ​

Enable API endpoint.

workato api-collections enable-endpoint --api-endpoint-id 789

workato api-clients list ​

List API clients used for programmatic access to Workato APIs with their permissions and status.

Usage ​

workato api-clients list [OPTIONS]

Options ​

Result ​

Displays API clients with ID, name, description, and permission scope.

Examples ​

List all API clients.

workato api-clients list

workato api-clients create ​

Create a new API client for programmatic access to Workato APIs.

Usage ​

workato api-clients create [OPTIONS]

Options ​

Result ​

Creates API client and returns client ID and initial access credentials.

Examples ​

Create API client.

workato api-clients create --name 'Integration Client' --description 'For external system integration'

workato guide topics ​

List all available documentation topics in the integrated help system.

Usage ​

workato guide topics

Result ​

Displays available help topics with descriptions and content summaries.

Examples ​

Show all help topics.

workato guide topics

workato guide search ​

Search the integrated documentation for specific terms or concepts.

Usage ​

workato guide search <QUERY> [OPTIONS]

Input ​

Options ​

Result ​

Returns relevant documentation sections with highlighted search terms.

Examples ​

Search for connection help.

workato guide search 'oauth connection'

Search within recipes topic.

workato guide search 'trigger' --topic recipes --max-results 5

workato guide content ​

Display the full content of a specific documentation topic.

Usage ​

workato guide content <TOPIC>

Input ​

Result ​

Shows complete documentation content for the specified topic.

Examples ​

Show recipe documentation.

workato guide content recipes

workato assets ​

List all assets in the current workspace including recipes, connections, data tables, and folders.

Usage ​

workato assets [OPTIONS]

Options ​

Result ​

Displays comprehensive asset inventory with types, names, IDs, and folder locations.

Examples ​

Show all assets.

workato assets

Export assets as JSON.

workato assets --output-format json

Environment Variables ​

The CLI supports the following environment variables:

• WORKATO_PROFILE: Default profile to use
• WORKATO_API_TOKEN: API token for authentication
• WORKATO_API_HOST: Custom API host URL

Global Patterns ​

The following patterns apply across all CLI commands and provide consistent behavior for authentication, data handling, and error management.

Authentication ​

All commands require authentication through:

• Profile configuration (recommended)
• Environment variables
• Command-line options

Pagination ​

List commands support pagination with:

• --page INTEGER: Page number (default: 1)
• --per-page INTEGER: Items per page (default varies, max: 100)

Output Formats ​

Many commands support:

• --output-format table: Human-readable table (default)
• --output-format json: Machine-readable JSON

Error Handling ​

The CLI provides the following features to assist you with errors:

• Detailed error messages with context
• Suggestions for common issues
• HTTP status code information for API errors
• Validation feedback for malformed inputs

Common Workflows ​

The following examples demonstrate typical workflows for getting started, developing recipes, managing connections, and working with APIs. These patterns can be combined and adapted to fit your specific requirements.

Initial Setup ​

workato init                    # Interactive setup
workato workspace              # Verify configuration
workato pull                   # Sync with workspace

Development Cycle ​

workato recipes validate --path recipe.json
workato push --restart-recipes
workato recipes list --running

Connection Management ​

workato connectors list --search salesforce
workato connections create --provider salesforce --name "Prod SF"
workato connections create-oauth --parent-id 123

API Management ​

workato api-collections create --name "Customer API"
workato api-collections list-endpoints --api-collection-id 456
workato api-collections enable-endpoint --api-endpoint-id 789