API Reference - Zapier

This page documents all available methods in the Zapier SDK.

Installation

npm install @zapier/zapier-sdk
npm install -D @zapier/zapier-sdk-cli @types/node typescript

Initialization

Option 1: Browser-based auth Running npx zapier-sdk login authenticates through your browser and stores a token on your local machine. As long as you have the CLI package installed as a development dependency, the SDK will automatically use it.

import { createZapierSdk } from "@zapier/zapier-sdk";

const zapier = createZapierSdk();

Option 2: Client credentials Provide a client ID and client secret. You can get these by running npx zapier-sdk create-client-credentials. This allows you to run the SDK in a server/serverless environment.

import { createZapierSdk } from "@zapier/zapier-sdk";

const zapier = createZapierSdk({
  credentials: {
    clientId: "your_client_id",
    clientSecret: "your_client_secret",
  },
});

Option 3: Direct token Provide a valid Zapier token. This is for partner OAuth or internal Zapier use.

import { createZapierSdk } from "@zapier/zapier-sdk";

const zapier = createZapierSdk({
  credentials: "your_zapier_token_here",
});

Accounts

`getProfile`

Get current user’s profile information Parameters:

Name	Type	Required	Description
`options`	`object`	No

Returns: Promise<ProfileItem> Example:

const { data: profile } = await zapier.getProfile();

Actions

`getAction`

Get detailed information about a specific action Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKey`	`string`	Yes	App key (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `actionType`	`string`	Yes	Action type that matches the action’s defined type
↳ `actionKey`	`string`	Yes	Action key to execute

Returns: Promise<ActionItem> Example:

const { data: action } = await zapier.getAction({
  appKey: "example-key",
  actionType: "read",
  actionKey: "example-key",
});

`getInputFieldsSchema`

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. Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKey`	`string`	Yes	App key (e.g., ‘SlackCLIAPI’ or slug like ‘github’) to get the input schema for
↳ `actionType`	`string`	Yes	Action type that matches the action’s defined type
↳ `actionKey`	`string`	Yes	Action key to get the input schema for
↳ `connectionId`	`string, number`	No	Connection ID to use when fetching the schema. Required if the action needs a connection to determine available fields.
↳ `inputs`	`object`	No	Current input values that may affect the schema (e.g., when fields depend on other field values)

Returns: Promise<InputSchemaItem> Example:

const { data: inputSchema } = await zapier.getInputFieldsSchema({
  appKey: "example-key",
  actionType: "read",
  actionKey: "example-key",
});

`listActions`

List all actions for a specific app Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKey`	`string`	Yes	App key of actions to list (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `actionType`	`string`	No	Filter actions by type
↳ `pageSize`	`number`	No	Number of actions per page
↳ `maxItems`	`number`	No	Maximum total items to return across all pages
↳ `cursor`	`string`	No	Cursor to start from

Returns: Promise<PaginatedResult<ActionItem>> Example:

// Get first page and a cursor for the second page
const { data: actions, nextCursor } = await zapier.listActions({
  appKey: "example-key",
});

// Or iterate over all pages
for await (const page of zapier.listActions({
  appKey: "example-key",
})) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const action of zapier
  .listActions({
    appKey: "example-key",
  })
  .items()) {
  // Do something with each action
}

`listInputFieldChoices`

Get the available choices for a dynamic dropdown input field Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKey`	`string`	Yes	App key (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `actionType`	`string`	Yes	Action type that matches the action’s defined type
↳ `actionKey`	`string`	Yes	Action key to execute
↳ `inputFieldKey`	`string`	Yes	Input field key to get choices for.
↳ `connectionId`	`string, number`	No	Connection ID to use for this action
↳ `inputs`	`object`	No	Current input values that may affect available choices
↳ `page`	`number`	No	Page number for paginated results
↳ `pageSize`	`number`	No	Number of choices per page
↳ `maxItems`	`number`	No	Maximum total items to return across all pages
↳ `cursor`	`string`	No	Cursor to start from

Returns: Promise<PaginatedResult<InputFieldChoiceItem>> Example:

// Get first page and a cursor for the second page
const { data: inputFieldChoices, nextCursor } =
  await zapier.listInputFieldChoices({
    appKey: "example-key",
    actionType: "read",
    actionKey: "example-key",
    inputFieldKey: "example-key",
  });

// Or iterate over all pages
for await (const page of zapier.listInputFieldChoices({
  appKey: "example-key",
  actionType: "read",
  actionKey: "example-key",
  inputFieldKey: "example-key",
})) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const inputFieldChoice of zapier
  .listInputFieldChoices({
    appKey: "example-key",
    actionType: "read",
    actionKey: "example-key",
    inputFieldKey: "example-key",
  })
  .items()) {
  // Do something with each inputFieldChoice
}

`listInputFields`

Get the input fields required for a specific action Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKey`	`string`	Yes	App key (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `actionType`	`string`	Yes	Action type that matches the action’s defined type
↳ `actionKey`	`string`	Yes	Action key to execute
↳ `connectionId`	`string, number`	No	Connection ID to use for this action
↳ `inputs`	`object`	No	Current input values that may affect available fields
↳ `pageSize`	`number`	No	Number of input fields per page
↳ `maxItems`	`number`	No	Maximum total items to return across all pages
↳ `cursor`	`string`	No	Cursor to start from

Returns: Promise<PaginatedResult<RootFieldItemItem>> Example:

// Get first page and a cursor for the second page
const { data: rootFieldItems, nextCursor } = await zapier.listInputFields({
  appKey: "example-key",
  actionType: "read",
  actionKey: "example-key",
});

// Or iterate over all pages
for await (const page of zapier.listInputFields({
  appKey: "example-key",
  actionType: "read",
  actionKey: "example-key",
})) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const rootFieldItem of zapier
  .listInputFields({
    appKey: "example-key",
    actionType: "read",
    actionKey: "example-key",
  })
  .items()) {
  // Do something with each rootFieldItem
}

`runAction`

Execute an action with the given inputs Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKey`	`string`	Yes	App key (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `actionType`	`string`	Yes	Action type that matches the action’s defined type
↳ `actionKey`	`string`	Yes	Action key to execute
↳ `connectionId`	`string, number`	No	Connection ID to use for this action
↳ `inputs`	`object`	No	Input parameters for the action
↳ `timeoutMs`	`number`	No	Maximum time to wait for action completion in milliseconds (default: 180000)
↳ `pageSize`	`number`	No	Number of results per page
↳ `maxItems`	`number`	No	Maximum total items to return across all pages
↳ `cursor`	`string`	No	Cursor to start from

Returns: Promise<PaginatedResult<ActionResultItem>> Example:

// Get first page and a cursor for the second page
const { data: actionResults, nextCursor } = await zapier.runAction({
  appKey: "example-key",
  actionType: "read",
  actionKey: "example-key",
});

// Or iterate over all pages
for await (const page of zapier.runAction({
  appKey: "example-key",
  actionType: "read",
  actionKey: "example-key",
})) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const actionResult of zapier
  .runAction({
    appKey: "example-key",
    actionType: "read",
    actionKey: "example-key",
  })
  .items()) {
  // Do something with each actionResult
}

Apps

`apps.{appKey}`

Bind a connection ID to an app Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `connectionId`	`string, number`	No	Connection ID to use for this action

Returns: Promise<AppProxy> Example:

const result = await zapier.apps.appKey();

`apps.{appKey}.{actionType}.{actionKey}`

Execute an action with the given inputs for the bound app, as an alternative to runAction Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `inputs`	`object`	No
↳ `connectionId`	`string, number`	No	Connection ID to use for this action
↳ `timeoutMs`	`number`	No	Maximum time to wait for action completion in milliseconds (default: 180000)

Returns: Promise<PaginatedResult<ActionResultItem>> Example:

// Get first page and a cursor for the second page
const { data: actionResults, nextCursor } =
  await zapier.apps.appKey.actionType.actionKey();

// Or iterate over all pages
for await (const page of zapier.apps.appKey.actionType.actionKey()) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const actionResult of zapier.apps.appKey.actionType
  .actionKey()
  .items()) {
  // Do something with each actionResult
}

`getApp`

Get detailed information about a specific app Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKey`	`string`	Yes	App key of app to fetch (e.g., ‘SlackCLIAPI’ or slug like ‘github’)

Returns: Promise<AppItem> Example:

const { data: app } = await zapier.getApp({
  appKey: "example-key",
});

`listApps`

List all available apps with optional filtering Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `appKeys`	`array`	No	Filter apps by app keys (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `search`	`string`	No	Search term to filter apps by name
↳ `pageSize`	`number`	No	Number of apps per page
↳ `maxItems`	`number`	No	Maximum total items to return across all pages
↳ `cursor`	`string`	No	Cursor to start from

Returns: Promise<PaginatedResult<AppItem>> Example:

// Get first page and a cursor for the second page
const { data: apps, nextCursor } = await zapier.listApps();

// Or iterate over all pages
for await (const page of zapier.listApps()) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const app of zapier.listApps().items()) {
  // Do something with each app
}

Client Credentials

`createClientCredentials`

Create new client credentials for the authenticated user Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `name`	`string`	Yes	Human-readable name for the client credentials
↳ `allowedScopes`	`array`	No	Scopes to allow for these credentials

Returns: Promise<any> Example:

const result = await zapier.createClientCredentials({
  name: "example-value",
});

`deleteClientCredentials`

Delete client credentials by client ID Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `clientId`	`string`	Yes	The client ID of the client credentials to delete

Returns: Promise<any> Example:

const result = await zapier.deleteClientCredentials({
  clientId: "example-id",
});

`listClientCredentials`

List client credentials for the authenticated user Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `pageSize`	`number`	No	Number of credentials per page
↳ `maxItems`	`number`	No	Maximum total items to return across all pages
↳ `cursor`	`string`	No	Cursor to start from

Returns: Promise<PaginatedResult<ClientCredentialsItem>> Example:

// Get first page and a cursor for the second page
const { data: clientCredentials, nextCursor } =
  await zapier.listClientCredentials();

// Or iterate over all pages
for await (const page of zapier.listClientCredentials()) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const clientCredentials of zapier.listClientCredentials().items()) {
  // Do something with each clientCredentials
}

Connections

`findFirstConnection`

Find the first connection matching the criteria Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `search`	`string`	No	Search term to filter connections by title
↳ `title`	`string`	No	Filter connections by exact title match (searches first, then filters locally)
↳ `owner`	`string`	No	Filter by owner, ‘me’ for your own connections or a specific user ID
↳ `appKey`	`string`	No	App key of connections to list (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `accountId`	`string`	No	Account ID to filter by
↳ `isExpired`	`boolean`	No	Filter by expired status

Returns: Promise<ConnectionItem> Example:

const { data: connection } = await zapier.findFirstConnection();

`findUniqueConnection`

Find a unique connection matching the criteria Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `search`	`string`	No	Search term to filter connections by title
↳ `title`	`string`	No	Filter connections by exact title match (searches first, then filters locally)
↳ `owner`	`string`	No	Filter by owner, ‘me’ for your own connections or a specific user ID
↳ `appKey`	`string`	No	App key of connections to list (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `accountId`	`string`	No	Account ID to filter by
↳ `isExpired`	`boolean`	No	Filter by expired status

Returns: Promise<ConnectionItem> Example:

const { data: connection } = await zapier.findUniqueConnection();

`getConnection`

Execute getConnection Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `connectionId`	`string, number`	No	Connection ID to use for this action

Returns: Promise<ConnectionItem> Example:

const { data: connection } = await zapier.getConnection();

`listConnections`

List available connections with optional filtering Parameters:

Name	Type	Required	Description
`options`	`object`	Yes
↳ `search`	`string`	No	Search term to filter connections by title
↳ `title`	`string`	No	Filter connections by exact title match (searches first, then filters locally)
↳ `owner`	`string`	No	Filter by owner, ‘me’ for your own connections or a specific user ID
↳ `appKey`	`string`	No	App key of connections to list (e.g., ‘SlackCLIAPI’ or slug like ‘github’)
↳ `connectionIds`	`array`	No	List of connection IDs to filter by
↳ `accountId`	`string`	No	Account ID to filter by
↳ `isExpired`	`boolean`	No	Filter by expired status
↳ `pageSize`	`number`	No	Number of connections per page
↳ `maxItems`	`number`	No	Maximum total items to return across all pages
↳ `cursor`	`string`	No	Cursor to start from

Returns: Promise<PaginatedResult<ConnectionItem>> Example:

// Get first page and a cursor for the second page
const { data: connections, nextCursor } = await zapier.listConnections();

// Or iterate over all pages
for await (const page of zapier.listConnections()) {
  // Do something with each page
}

// Or iterate over individual items across all pages
for await (const connection of zapier.listConnections().items()) {
  // Do something with each connection
}

HTTP Requests

`fetch`

Make authenticated HTTP requests to any API through Zapier. Pass a connectionId to automatically inject the user’s stored credentials (OAuth tokens, API keys, etc.) into the outgoing request. Mirrors the native fetch(url, init?) signature with additional Zapier-specific options. Parameters:

Name	Type	Required	Description
`url`	`string, custom`	Yes	The full URL of the API endpoint to call (proxied through Zapier’s Relay service)
`init`	`object`	No	Request options including method, headers, body, and authentication
↳ `method`	`string`	No	HTTP method for the request (defaults to GET)
↳ `headers`	`object`	No	HTTP headers to include in the request
↳ `body`	`string, custom, custom, record`	No	Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly
↳ `connectionId`	`string, number`	No	Connection ID to use for this action
↳ `callbackUrl`	`string`	No	URL to send async response to (makes request async)

Returns: Promise<Response> Example:

const result = await zapier.fetch("example-value", { key: "value" });

Getting Started

Reference

​Installation

​Initialization

​Accounts

​getProfile

​Actions

​getAction

​getInputFieldsSchema

​listActions

​listInputFieldChoices

​listInputFields

​runAction

​Apps

​apps.{appKey}

​apps.{appKey}.{actionType}.{actionKey}

​getApp

​listApps

​Client Credentials

​createClientCredentials

​deleteClientCredentials

​listClientCredentials

​Connections

​findFirstConnection

​findUniqueConnection

​getConnection

​listConnections

​HTTP Requests

​fetch

Installation

Initialization

Accounts

`getProfile`

Actions

`getAction`

`getInputFieldsSchema`

`listActions`

`listInputFieldChoices`

`listInputFields`

`runAction`

Apps

`apps.{appKey}`

`apps.{appKey}.{actionType}.{actionKey}`

`getApp`

`listApps`

Client Credentials

`createClientCredentials`

`deleteClientCredentials`

`listClientCredentials`

Connections

`findFirstConnection`

`findUniqueConnection`

`getConnection`

`listConnections`

HTTP Requests

`fetch`