API Reference

Contact us

Zapier

Get the Output Fields for a particular Action, using the provided authentication and inputs.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap:write` OAuth scope.

Get Output Fields

The meta object returned in paginated response bodies.

The total number of objects in the collection represented by the endpoint.

A unique identifier for this particular occurrence of the problem.

A human-readable explanation specific to this occurrence of the problem.

An object containing references to the primary source of the error.

The HTTP status code applicable to this problem.

Populates the `source` object inside our error responses.

A string indicating the name of a single request header which caused the error.

A string indicating which URI query parameter caused the error.

Pointer to the value in the request document that caused the error e.g. `/actions`.

The links object returned in paginated response bodies.

The URL of the next page of paginated results.

The URL of the previous page of paginated results.

The common data object that includes inputs and an authentication id.

An Authentication ID, as provided by the `/authentications` endpoint.

Whether to retrieve live samples for the field. While this can be helpful in supporting the identification of an output, note that this has latency implications as it may require an additional request to 3rd party services. This is not supported for `WRITE` actions, please use [step testing](https://docs.api.zapier.com/guides/custom-flows/testing-a-step) instead.

The current set of input fields in a JSON object, where each key is the `id` of an Input Field, and the corresponding value the current value of the field.

Used for paginating results. Specifies the maximum number of items to return per page.

Used for paginating results. Specifies the offset to use. Defaults to 0

OAuthAccessTokenAuthentication

Base Response definition to be used in other Response Serializers.

Be sure to include the `data` field after using this class

Add automation to your product with Zapier.

Zapier Partner Solutions

Our most powerful tool for building native workflows in your product

Integrate the Workflow API

This guide walks through the entire process of building an automated workflow for your users to use -- front picking apps, adding authentication, filling inputs and publishing.

How to Build a Workflow

Fields and Fieldsets

An Action is an operation that can be performed against a third-party API; either a `READ` or a `WRITE`.

Selecting an Action

Support users in selecting 3rd party authentications, either through an existing authentication or by adding new.

Selecting an Authentication

Creating workflows using the Zapier Workflow API is a recent addition, and there are some known limitations.

Known Limitations

Listing apps available on Zapier is a simple way to show users all of what's possible on Zapier

Retrieving Apps on Zapier

Listing a users zaps reveals existing workflows created by users.

Retrieving a list of users Zaps

Zap templates are pre-made Zaps that help users discover popular use cases for automating their work. Each template features a specific use case and the apps needed for it to work.

Retrieving Zap Templates

With an embedded Zap editor in your product, your users can create and edit their Zaps without leaving your app.

Embedding the Zapier Editor

The Workflow Element is a prebuilt UI component that offers the quickest—and easiest—way to surface your Zapier integration directly within your own product.

Embed the Workflow Element

Keeping our elements secure and usable is critical at Zapier

Element Security

Insights are available to review the performance of your embed, and track usage growth.

Embed Insights

Prefills allow you to define the input fields on behalf of the user, simplying the experience of setting up their Zap.

Pre-filled Zaps

Quick Account Creation is a seamless, accelerated sign-up feature allowing first time Zapier users to skip the standard sign-up procedure and onboarding survey. Enabling Quick Account Creation as part of your embed tool code helps provide a more frictionless experience for end users.

Quick Account Creation

Authenticate with The Zapier Workflow API

Zapier Authentication

Rate limits when accessing the Workflow API   

Rate Limiting

This endpoint returns a list of apps sorted popularity. See [here](/guides/list-apps) to get started.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

Get Apps [v1]

This endpoint returns a list of apps sorted popularity. See [here](/guides/list-apps) to get started.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap` OAuth scope.

Get Apps [v2]

List of Zap categories

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

Get Categories

This endpoint returns the authenticated user information

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `profile` OAuth scope.

User Profile

Create a new user and obtain an access token. See [here](/guides/quac/intro-quac#add-support-to-the-workflow-api) to get started.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

Create Account

List popular Zap Templates using your app. See [here](/guides/list-zap-templates) to get started.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

Get Zap Templates

This endpoint returns a list of Zaps for the authenticated Zapier user.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap` OAuth scope.

Get Zaps [v1]

This endpoint returns a suggested Zap and pre-filled URL to Zapier from a given prompt.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

Guess a Zap

This endpoint returns a list of Zaps for the authenticated Zapier user.

The `expand` array can be used to expand selected fields into full objects in the response.  Inputs with keys can
also be passed to filter Zaps by certain criteria.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap`, or `zap:all` OAuth scope.

Get Zaps [v2]

This URL creates a new Zap based on a series of steps and a given title.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap:write` OAuth scope.

Create a Zap

Fetch the available actions for the provided App. It's typical to filter by type so that only actions that make sense for a particular step are shown. Action IDs may not be reused, see our documentation [here](https://docs.api.zapier.com/guides/custom-flows/Hardcoding-an-Action) for how to hardcode a particular action.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap` OAuth scope.

Get Actions

Get the Input Fields for a particular Action, using the provided authentication and inputs.  See [here](/guides/getting-started/Fields-and-Fieldsets) for more information.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap:write` OAuth scope.

Get Input Fields

Get the possible values for an Input Field that is marked as `SELECT`.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap` OAuth scope.

Get Choices

Tests the action (step) in the third party api, using the provided authentication and inputs.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap:write` OAuth scope.

Step Test

Fetch the available Authentications for the provided App. This will only return Authentications that are owned by the user and not those that are shared with them, since it's not possible to create Zaps with Authentications you don't own.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `authentication` OAuth scope.

Get Authentications

Creates a new Authentication for the provided App.  See [here](/guides/custom-flows/adding-an-authentication) to get started.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `authentication:write` OAuth scope.

Create Authentication

Creates a new Workflow Step based on a single provided step and returns a webhook URL that can be used to invoke the Workflow Step and retrieve a response. When creating a Workflow write action step, field values can be hardcoded, or they can contain mapped values. The mapped values should be surrounded with double curly braces.

In the example request body the Workflow Step contains the field values `email`, `name`, `phone`, and `address` in double curly braces. Then the webhook URL returned can be called with a `POST` request containing a JSON body in the following format:

```
{
"email": "user@example.com",
"name": "John Doe",
"phone": "1234567890",
"address": "123 Maple Lane"
}
```

Note that authentications may become invalid over time, and if this occurs, users will be notified by email to fix their authentication. If the authentication is not fixed, trying to run the Workflow Step will time out. Workflow Steps are also (for now) visible and editable as Zaps at https://zapier.com/app/zaps. If a user turns off a Workflow Step Zap, the request will similarly time out. Finally, it is possible that a user can edit the Workflow Step Zap such that it returns unexpected outputs.

This API is rate limited. See [Rate Limiting](https://docs.api.zapier.com/api-reference/getting-started/rate-limiting) for more details.

#### OAuth
This endpoint requires the `zap:write` OAuth scope.

Create a Workflow step

Errors in the API follow the <a href="https://jsonapi.org/format/#error-objects" target="_blank">recommendation</a> from the JSON API spec.

Errors

Pagination

Requests

Responses for the API follow the <a href="https://jsonapi.org/format/#fetching-resources-responses-200" target="_blank">JSON API spec</a> for fetching resources.

Getting Started With the API

Apps

Categories

Accounts

Zap Templates

Zaps

Actions

Authentications

Experimental

Schemas

Get Output Fields

OAuth

Authorizations

Path Parameters

Body

Response