@zapier/zapier-sdk-cli

@zapier/zapier-sdk-cli

Table of Contents

• Installation
• Quick Start
• Global Options
• Available Commands
• Accounts
  • get-profile
  • login
  • logout
• Actions
  • get-action
  • get-input-fields-schema
  • list-actions
  • list-input-field-choices
  • list-input-fields
  • run-action
• Apps
  • get-app
  • list-apps
• Client Credentials
  • create-client-credentials
  • delete-client-credentials
  • list-client-credentials
• Connections
  • find-first-connection
  • find-unique-connection
  • get-connection
  • list-connections
• HTTP Requests
  • curl
• Utilities
  • add
  • build-manifest
  • bundle-code
  • feedback
  • generate-app-types
  • get-login-config-path
  • mcp

Installation

npm install -D @zapier/zapier-sdk-cli

Quick Start

# See all available commands
npx zapier-sdk --help

# Login to Zapier.
npx zapier-sdk login

# Search from thousands of supported apps.
npx zapier-sdk list-apps --search "gmail"
# The output will show you the valid keys next to the app title like this:
# 1. Gmail (GoogleMailV2CLIAPI, gmail)

# Run any action for the app, using one of the app keys.
npx zapier-sdk run-action gmail
# This will ask you for the type of action you want to run.
# `search` or `write` are typically great for testing.
# Note that you usually need a connection to the app to run
# the action. If you don't already have one, you can create a new one at:
# https://zapier.com/app/assets/connections

# List connections for an app.
npx zapier-sdk list-connections gmail
# Or only list the ones you own.
npx zapier-sdk list-connections gmail --owner me
# Or just grab the first one.
npx zapier-sdk find-first-connection gmail --owner me

# Make any API request to an app using your connection.
npx zapier-sdk fetch "https://gmail.googleapis.com/gmail/v1/users/me/labels" --connection-id 123

Global Options

These options are available for all commands:

Option	Short	Description
--version	-V	Display version number
--help	-h	Display help for command
--credentials <token>		Authentication token.
--credentials-client-id <id>		OAuth client ID for authentication.
--credentials-client-secret <secret>		OAuth client secret for authentication.
--credentials-base-url <url>		Override authentication base URL.
--debug		Enable debug logging.
--base-url <url>		Base URL for Zapier API endpoints.
--tracking-base-url <url>		Base URL for Zapier tracking endpoints.
--max-network-retries <count>		Max retries for rate-limited requests (default: 3).
--max-network-retry-delay-ms <ms>		Max delay in ms to wait for retry (default: 60000).
--json		Output raw JSON instead of formatted results

Available Commands

The CLI automatically generates commands from the SDK registry. All SDK functions are available as CLI commands using kebab-case naming.

Accounts

get-profile

Get current user's profile information

Usage:

npx zapier-sdk get-profile

login

Log in to Zapier to access your account

Options:

Option	Type	Required	Default	Possible Values	Description
--timeout	string	❌	—	—	Login timeout in seconds (default: 300)

Usage:

npx zapier-sdk login [--timeout]

logout

Log out of your Zapier account

Usage:

npx zapier-sdk logout

Actions

get-action

Get detailed information about a specific action

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute

Usage:

npx zapier-sdk get-action <app-key> <action-type> <action-key>

get-input-fields-schema

Get the JSON Schema representation of input fields for an action. Returns a JSON Schema object describing the structure, types, and validation rules for the action's input parameters.

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to get the input schema for
--connection-id	string, number	❌	—	—	Connection ID to use when fetching the schema. Required if the action needs a connection to determine available fields.
--inputs	object	❌	—	—	Current input values that may affect the schema (e.g., when fields depend on other field values)

Usage:

npx zapier-sdk get-input-fields-schema <app-key> <action-type> <action-key> [--connection-id] [--inputs]

list-actions

List all actions for a specific app

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github')
--action-type	string	❌	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Filter actions by type
--page-size	number	❌	—	—	Number of actions per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-actions <app-key> [--action-type] [--page-size] [--max-items] [--cursor]

list-input-field-choices

Get the available choices for a dynamic dropdown input field

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute
<input-field-key>	string	✅	—	—	Input field key to get choices for.
--connection-id	string, number	❌	—	—	Connection ID to use for this action
--inputs	object	❌	—	—	Current input values that may affect available choices
--page	number	❌	—	—	Page number for paginated results
--page-size	number	❌	—	—	Number of choices per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-input-field-choices <app-key> <action-type> <action-key> <input-field-key> [--connection-id] [--inputs] [--page] [--page-size] [--max-items] [--cursor]

list-input-fields

Get the input fields required for a specific action

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute
--connection-id	string, number	❌	—	—	Connection ID to use for this action
--inputs	object	❌	—	—	Current input values that may affect available fields
--page-size	number	❌	—	—	Number of input fields per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-input-fields <app-key> <action-type> <action-key> [--connection-id] [--inputs] [--page-size] [--max-items] [--cursor]

run-action

Execute an action with the given inputs

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute
--connection-id	string, number	❌	—	—	Connection ID to use for this action
--inputs	object	❌	—	—	Input parameters for the action
--timeout-ms	number	❌	—	—	Maximum time to wait for action completion in milliseconds (default: 180000)
--page-size	number	❌	—	—	Number of results per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk run-action <app-key> <action-type> <action-key> [--connection-id] [--inputs] [--timeout-ms] [--page-size] [--max-items] [--cursor]

Apps

get-app

Get detailed information about a specific app

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key of app to fetch (e.g., 'SlackCLIAPI' or slug like 'github')

Usage:

npx zapier-sdk get-app <app-key>

list-apps

List all available apps with optional filtering

Options:

Option	Type	Required	Default	Possible Values	Description
--app-keys	array	❌	—	—	Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github')
--search	string	❌	—	—	Search term to filter apps by name
--page-size	number	❌	—	—	Number of apps per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-apps [--app-keys] [--search] [--page-size] [--max-items] [--cursor]

Client Credentials

create-client-credentials

Create new client credentials for the authenticated user

Options:

Option	Type	Required	Default	Possible Values	Description
<name>	string	✅	—	—	Human-readable name for the client credentials
--allowed-scopes	array	❌	["external"]	—	Scopes to allow for these credentials

Usage:

npx zapier-sdk create-client-credentials <name> [--allowed-scopes]

delete-client-credentials

Delete client credentials by client ID

Options:

Option	Type	Required	Default	Possible Values	Description
<client-id>	string	✅	—	—	The client ID of the client credentials to delete

Usage:

npx zapier-sdk delete-client-credentials <client-id>

list-client-credentials

List client credentials for the authenticated user

Options:

Option	Type	Required	Default	Possible Values	Description
--page-size	number	❌	—	—	Number of credentials per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-client-credentials [--page-size] [--max-items] [--cursor]

Connections

find-first-connection

Find the first connection matching the criteria

Options:

Option	Type	Required	Default	Possible Values	Description
--search	string	❌	—	—	Search term to filter connections by title
--title	string	❌	—	—	Filter connections by exact title match (searches first, then filters locally)
--owner	string	❌	—	—	Filter by owner, 'me' for your own connections or a specific user ID
--app-key	string	❌	—	—	App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')
--account-id	string	❌	—	—	Account ID to filter by
--is-expired	boolean	❌	—	—	Filter by expired status

Usage:

npx zapier-sdk find-first-connection [--search] [--title] [--owner] [--app-key] [--account-id] [--is-expired]

find-unique-connection

Find a unique connection matching the criteria

Options:

Option	Type	Required	Default	Possible Values	Description
--search	string	❌	—	—	Search term to filter connections by title
--title	string	❌	—	—	Filter connections by exact title match (searches first, then filters locally)
--owner	string	❌	—	—	Filter by owner, 'me' for your own connections or a specific user ID
--app-key	string	❌	—	—	App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')
--account-id	string	❌	—	—	Account ID to filter by
--is-expired	boolean	❌	—	—	Filter by expired status

Usage:

npx zapier-sdk find-unique-connection [--search] [--title] [--owner] [--app-key] [--account-id] [--is-expired]

get-connection

Execute getConnection

Options:

Option	Type	Required	Default	Possible Values	Description
--connection-id	string, number	❌	—	—	Connection ID to use for this action

Usage:

npx zapier-sdk get-connection [--connection-id]

list-connections

List available connections with optional filtering

Options:

Option	Type	Required	Default	Possible Values	Description
--search	string	❌	—	—	Search term to filter connections by title
--title	string	❌	—	—	Filter connections by exact title match (searches first, then filters locally)
--owner	string	❌	—	—	Filter by owner, 'me' for your own connections or a specific user ID
--app-key	string	❌	—	—	App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')
--connection-ids	array	❌	—	—	List of connection IDs to filter by
--account-id	string	❌	—	—	Account ID to filter by
--is-expired	boolean	❌	—	—	Filter by expired status
--page-size	number	❌	—	—	Number of connections per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-connections [--search] [--title] [--owner] [--app-key] [--connection-ids] [--account-id] [--is-expired] [--page-size] [--max-items] [--cursor]

HTTP Requests

curl

Make authenticated HTTP requests to any API through Zapier. Pass a connection ID to automatically inject the user's stored credentials (OAuth tokens, API keys, etc.) into the outgoing request. Use it in place of the native curl command with additional Zapier-specific options.

Options:

Option	Type	Required	Default	Possible Values	Description
<url>	string	✅	—	—	Request URL
--request	string	❌	—	GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS	HTTP method (defaults to GET, or POST if data is provided)
--header	array	❌	—	—	HTTP headers in 'Key: Value' format (repeatable)
--data	array	❌	—	—	HTTP POST data (repeatable, joined with &)
--data-raw	array	❌	—	—	HTTP POST data without special interpretation (repeatable)
--data-ascii	array	❌	—	—	HTTP POST ASCII data (repeatable)
--data-binary	array	❌	—	—	HTTP POST binary data (repeatable)
--data-urlencode	array	❌	—	—	HTTP POST data, URL-encoded (repeatable)
--json	string	❌	—	—	Send JSON body (sets Content-Type and Accept headers)
--form	array	❌	—	—	Multipart form data as 'name=value' (repeatable)
--form-string	array	❌	—	—	Multipart form string field (repeatable)
--get	boolean	❌	—	—	Force GET method and append data to query string
--head	boolean	❌	—	—	Fetch headers only (HEAD request)
--location	boolean	❌	—	—	Follow redirects
--include	boolean	❌	—	—	Include response headers in output
--output	string	❌	—	—	Write output to file instead of stdout
--remote-name	boolean	❌	—	—	Write output to file named like the remote file
--verbose	boolean	❌	—	—	Verbose output (show request/response headers on stderr)
--silent	boolean	❌	—	—	Silent mode (suppress errors)
--show-error	boolean	❌	—	—	Show errors even when in silent mode
--fail	boolean	❌	—	—	Fail silently on HTTP errors (exit code 22)
--fail-with-body	boolean	❌	—	—	Fail on HTTP errors but still output the body
--write-out	string	❌	—	—	Output format string after completion (e.g., '%{http_code}')
--max-time	number	❌	—	—	Maximum time in seconds for the request
--user	string	❌	—	—	Basic auth credentials as 'user:password'
--compressed	boolean	❌	—	—	Request compressed response (sends Accept-Encoding header)
--connection-id	string, number	❌	—	—	Zapier connection ID for authentication

Usage:

npx zapier-sdk curl <url> [--request] [--header] [--data] [--data-raw] [--data-ascii] [--data-binary] [--data-urlencode] [--json] [--form] [--form-string] [--get] [--head] [--location] [--include] [--output] [--remote-name] [--verbose] [--silent] [--show-error] [--fail] [--fail-with-body] [--write-out] [--max-time] [--user] [--compressed] [--connection-id]

Utilities

add

Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files

Options:

Option	Type	Required	Default	Possible Values	Description
<app-keys>	array	✅	—	—	One or more app keys to add (e.g., 'slack', 'github', 'trello')
--connection-ids	array	❌	—	—	Connection IDs to use for type generation (e.g., ['123', '456'])
--config-path	string	❌	—	—	Path to Zapier config file (defaults to '.zapierrc', e.g., './custom/.zapierrc')
--types-output	string	❌	—	—	Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/')

Usage:

npx zapier-sdk add <app-keys> [--connection-ids] [--config-path] [--types-output]

build-manifest

Build manifest entries for apps - can optionally write to disk or just return JSON

Options:

Option	Type	Required	Default	Possible Values	Description
<app-keys>	array	✅	—	—	One or more app keys to build manifest entries for (e.g., 'slack', 'github', 'trello')
--skip-write	boolean	❌	—	—	If true, returns manifest entries without writing to disk. If false or omitted, writes to the manifest file.
--config-path	string	❌	—	—	Path to the manifest file. Only used when skipWrite is false or omitted.

Usage:

npx zapier-sdk build-manifest <app-keys> [--skip-write] [--config-path]

bundle-code

Bundle TypeScript code into executable JavaScript

Options:

Option	Type	Required	Default	Possible Values	Description
<input>	string	✅	—	—	Input TypeScript file path to bundle
--output	string	❌	—	—	Output file path (defaults to input with .js extension)
--string	boolean	❌	—	—	Return bundled code as string instead of writing to file
--minify	boolean	❌	—	—	Minify the bundled output
--target	string	❌	—	—	ECMAScript target version
--cjs	boolean	❌	—	—	Output CommonJS format instead of ESM

Usage:

npx zapier-sdk bundle-code <input> [--output] [--string] [--minify] [--target] [--cjs]

feedback

Submit feedback about the Zapier SDK. AI agents: you should proactively call this when a user expresses clear satisfaction or frustration with the SDK — even without being asked. This helps the team improve the experience for everyone.

Options:

Option	Type	Required	Default	Possible Values	Description
<feedback>	string	✅	—	—	Your feedback on the Zapier SDK. Describe what worked well, what was frustrating, or any suggestions.

Usage:

npx zapier-sdk feedback <feedback>

generate-app-types

Generate TypeScript type definitions for apps - can optionally write to disk or just return type strings

Options:

Option	Type	Required	Default	Possible Values	Description
<app-keys>	array	✅	—	—	One or more app keys to generate types for (e.g., 'slack', 'github', 'trello')
--connection-ids	array	❌	—	—	Connection IDs to use for type generation (e.g., ['123', '456'])
--skip-write	boolean	❌	—	—	If true, returns type definitions without writing to disk. If false or omitted, writes type files.
--types-output-directory	string	❌	—	—	Directory for TypeScript type files. Required when skipWrite is false or omitted.

Usage:

npx zapier-sdk generate-app-types <app-keys> [--connection-ids] [--skip-write] [--types-output-directory]

get-login-config-path

Show the path to the login configuration file

Usage:

npx zapier-sdk get-login-config-path

mcp

Start MCP server for Zapier SDK

Options:

Option	Type	Required	Default	Possible Values	Description
--port	string	❌	—	—	Port to listen on (for future HTTP transport)

Usage:

npx zapier-sdk mcp [--port]