Partner API Docs#

The Partner API is for partners that wish to have more flexibility and control over a user's experience with Zapier within their product. With the Partner API, you can:

  • Have complete style control over how you present Zap templates in your product. The Partner API gives you access to the raw Zap Template data so you can give your users access to your Zap template with your product's style, look and feel.
  • Get access to all your Zap templates and give your users the ability to search to quickly find the one they need.
  • Streamline Zap setup by pre-filling fields on behalf of your users.
  • Show users the Zaps they have set up from right within your product keeping them on your site longer and giving them complete confidence in their Zapier integration.

This API is currently for approved partners only. If you'd like to use this API, request access using this form.

Want to better understand what you can achieve with the Partner API? See how other partners have used the API to create a native Zapier integration for their users.

↑ Was this documentation useful? Yes No

Authentication#

There are two ways to authenticate with the Partner API.

  1. Your application's client_id which you will receive once you are approved for access to the API
  2. A user's access token

Which authentication method you should use depends on which endpoint(s) you are using. Review each endpoint's documentation to understand which parameters are required.

Note: while we do generate a client_secret, the type of grant we use (implicit) doesn't need it so it's not something we provide.

Access Token#

For resources that require a valid access token you can use the OAuth2 protocol. At the moment, we only permit the implicit grant type. Should your use case require a different grant type send us your request.

Procuring a Token#

Construct the following URL, and redirect the user to authorize your application:

https://zapier.com/oauth/authorize?client_id={client_id}&redirect_uri={redirect_uri}&scope={scope}

Parameter Requirement Explanation
client_id Required Your application ID.
redirect_uri Required The URI you provided in the sign-up form. If you need to modify this, you'll need to send us a request.
response_type Required Use token.
scope Optional Space (%20) separated variable. See each resource for their required scope, if any.
approval_prompt Optional One of auto or force. Use auto if the second authorization (before expiration of previous token) should not prompt the user to re-authorize. Use force if the user should authorize your application again.
state Optional A unique string to help your application guard against XSRF.
Example Prompt#

Example OAuth2 Authorization Prompt

Receiving the Token, or Error#

If the user cancels, or approves the authorization the user will be redirected to your redirect_uri with the following example urls:

Approved

http://your.redirect.url/#access_token=iuqhw8egojqenduvybtoken_type=Bearer&expires_in=36000&scope=zap

Cancelled

http://your.redirect.url/?error=access_denied

Your application should use JavaScript to parse the hash parameter and use the token as needed. The access token will not expire. If ever invalid, however, provide the user with the authorize flow once more. In the implicit grant type, there are no refresh tokens. You can use a hidden iframe with approval_prompt=auto, or ask the user to authorize once more, to receive new tokens.

Using the token:#

Preferred use of the tokens is via an HTTP Authorization Header.

curl -H "Authorization: Bearer {token}" "https://api.zapier.com/v1/zaps"

↑ Was this documentation useful? Yes No

Error Handling#

Zapier uses HTTP response codes to indicate the success or failure of an API request.

Code Status Explanation
200 OK Successful request.
403 Authentication Not authorized.
404 Not Found The resource requested was not found.
5xx Server Error A fatal error occurred while processing the request. Try again.

All errors will be JSON object with a String array of errors:

{
  "errors": ["Malformed request"]
}
↑ Was this documentation useful? Yes No

Resources#

Zaps#

URL Protected By Required Scopes
api.zapier.com/v1/zaps Access Token zap

Notes#

  1. The zaps returned are narrowed/filtered by your Zapier app. For example, if you are Trello you'll only be returned a user's Zap that contain Trello in one of the steps of the Zap.

  2. If your app is built with the Zapier CLI the Zaps returned are for any version of your app.

Arguments#

Available parameters to the Zaps resource:

parameter requirement notes
params__{KEY}={VALUE} Optional Return Zaps that have a specific key/value set in the params (settings) of the Zap. Note the app parameter must be included as well.

EXAMPLE REQUEST#

curl -H "Authorization: Bearer {token}" "https://api.zapier.com/v1/zaps"

Example Requests#

Get all Zaps in the user's account (note this will only include the OAuth app that is associated with the Zapier app).

curl -H "Authorization: Bearer {token}" -L "https://api.zapier.com/v1/zaps"

Get all Zaps in the user's account that have a particular Trello board (assuming the OAuth app is Trello).

curl -H "Authorization: Bearer {token}" -L "https://api.zapier.com/v1/zaps?&params__board=BOARD_ID"

EXAMPLE RESPONSE#

{
  "objects": [
    {
      "id": 125,
      "modified_at": "2017-03-22T09:38:11-05:00",
      "state": "on",
      "steps": [
        {
          "app": {
            "description": "Typeform helps you ask awesomely online! If you ever need to run a survey, questionnaire, form, contest etc... Typeform will help you achieve it beautifully across all devices, every time, using its next generation platform.",
            "hex_color": "8bcbca",
            "id": 4259,
            "image": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.png",
            "images": {
              "url_128x128": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.128x128.png",
              "url_16x16": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.16x16.png",
              "url_32x32": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.32x32.png",
              "url_64x64": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.64x64.png"
            },
            "api": "TypeformDevAPI",
            "slug": "typeform",
            "title": "Typeform",
            "url": "https://zapier.com/zapbook/typeform/"
          },
          "type_of": "read"
        },
        {
          "app": {
            "description": "Trello is team collaboration tool that lets you organize anything and everything to keep your projects on task.",
            "hex_color": "0079bf",
            "id": 4192,
            "image": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.png",
            "images": {
              "url_128x128": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.128x128.png",
              "url_16x16": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.16x16.png",
              "url_32x32": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.32x32.png",
              "url_64x64": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.64x64.png"
            },
            "api": "TrelloAPI",
            "slug": "trello",
            "title": "Trello",
            "url": "https://zapier.com/zapbook/trello/"
          },
          "type_of": "write"
        }
      ],
      "title": "Create Trello cards from new Typeform entries",
      "url": "https://zapier.com/app/editor/125"
    },
    {
      "id": 123,
      "modified_at": "2017-03-21T22:04:05-05:00",
      "state": "off",
      "steps": [
        {
          "app": {
            "description": "Typeform helps you ask awesomely online! If you ever need to run a survey, questionnaire, form, contest etc... Typeform will help you achieve it beautifully across all devices, every time, using its next generation platform.",
            "hex_color": "8bcbca",
            "id": 4259,
            "image": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.png",
            "images": {
              "url_128x128": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.128x128.png",
              "url_16x16": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.16x16.png",
              "url_32x32": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.32x32.png",
              "url_64x64": "https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.64x64.png"
            },
            "api": "TypeformDevAPI",
            "slug": "typeform",
            "title": "Typeform",
            "url": "https://zapier.com/zapbook/typeform/"
          },
          "type_of": "read"
        },
        {
          "app": {
            "description": "Trello is team collaboration tool that lets you organize anything and everything to keep your projects on task.",
            "hex_color": "0079bf",
            "id": 4192,
            "image": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.png",
            "images": {
              "url_128x128": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.128x128.png",
              "url_16x16": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.16x16.png",
              "url_32x32": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.32x32.png",
              "url_64x64": "https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.64x64.png"
            },
            "api": "TrelloAPI",
            "slug": "trello",
            "title": "Trello",
            "url": "https://zapier.com/zapbook/trello/"
          },
          "type_of": "write"
        }
      ],
      "title": "Create Trello cards from new Typeform entries",
      "url": "https://zapier.com/app/editor/123"
    }
  ]
}

The Zap Object#

attribute type notes
id Number The ID of the Zap.
modified_at Date The last modified date time.
state String One of 'on', 'off', or 'draft'
steps Array An array steps in the Zap. See below.
title String The name of the Zap, if any, otherwise null.
url String An absolute url to the Zap (to edit).
{
  "id": 125,
  "modified_at": "2017-03-22T09:38:11-05:00",
  "state": "on",
  "steps": [{ "See Step object below ..." }],
  "title": "Create Trello cards from new Typeform entries",
  "url": "https://zapier.com/app/editor/125"
}

The Zap Step Object#

attribute type notes
type_of String One of 'read', 'write', 'filter', 'search', or 'search_or_write'
app App The app for the step. See below.
{
  "app": {"See the App object below ..."},
  "type_of": "read"
}

Zap Templates#

URL Protected By
api.zapier.com/v1/zap-templates Client ID

Arguments#

Available parameters to the Zap templates resource:

parameter requirement notes
client_id Required Your application client ID.
templates Optional A comma separated list of specific Zap templates.
apps Optional A comma separated list of Zapier Apps to match Zap templates against. Note: Your app will always be one of the apps.
limit Optional (defaults to 5, max of 100) Limit the number of Zap templates returned.

Example Requests#

Get all Zap templates for my app.

curl -L "https://api.zapier.com/v1/zap-templates?client_id=${client_id}"

Get all Zap templates that include my app and another.

curl -L "https://api.zapier.com/v1/zap-templates?client_id=${client_id}&apps=mailchimp"

EXAMPLE RESPONSE#

[{
  "description": "<p>Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.</p>\n\n<h2>How this Facebook Lead Ads-MailChimp integration works</h2>\n\n<ol>\n<li>Someone fills out one of your Facebook Lead Ads</li>\n<li>Zapier adds that individual to a specified list in MailChimp</li>\n</ol>\n\n<h2>Apps involved</h2>\n\n<ul>\n<li>Facebook Lead Ads</li>\n<li>MailChimp</li>\n</ul>\n",
  "title": "Subscribe new Facebook Lead Ad leads to a MailChimp list",
  "url": "https://zapier.com/zapbook/zaps/10127/subscribe-new-facebook-lead-ads-mailchimp-list/",
  "type": "guided_zap",
  "status": "published",
  "description_raw": "Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.\r\n\r\n## How this Facebook Lead Ads-MailChimp integration works\r\n\r\n1. Someone fills out one of your Facebook Lead Ads\r\n2. Zapier adds that individual to a specified list in MailChimp\r\n\r\n## Apps involved\r\n\r\n- Facebook Lead Ads\r\n- MailChimp",
  "slug": "subscribe-new-facebook-lead-ads-mailchimp-list",
  "description_plain": "Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.\n\nHow this Facebook Lead Ads-MailChimp integration works\n\nSomeone fills out one of your Facebook Lead Ads\n\nZapier adds that individual to a specified list in MailChimp\n\nApps involved\n\nFacebook Lead Ads\n\nMailChimp",
  "steps": [
    {
      "description": "Facebook lead ads make signing up for business information easy for people and more valuable for businesses. The Facebook lead ad app is useful for marketers who want to automate actions on their leads.",
      "title": "Facebook Lead Ads",
      "url": "https://zapier.com/zapbook/facebook-lead-ads/",
      "image": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.png",
      "api": "FacebookLeadsAPI",
      "slug": "facebook-lead-ads",
      "hex_color": "3b5998",
      "images": {
        "url_128x128": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.128x128.png",
        "url_64x64": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.64x64.png",
        "url_16x16": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.16x16.png",
        "url_32x32": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.32x32.png"
      },
      "id": 3535
    },
    {
      "description": "MailChimp is an email marketing service provider, founded in 2001. It has 6 million users that collectively send over 10 billion emails through the service each month.",
      "title": "MailChimp",
      "url": "https://zapier.com/zapbook/mailchimp/",
      "image": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.png",
      "api": "MailChimpAPI",
      "slug": "mailchimp",
      "hex_color": "239AB9",
      "images": {
        "url_128x128": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.128x128.png",
        "url_64x64": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.64x64.png",
        "url_16x16": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.16x16.png",
        "url_32x32": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.32x32.png"
      },
      "id": 6
    }
  ],
  "create_url": "https://zapier.com/partner/embed/facebook-lead-ads/create/10127",
  "id": 10127
}]

My Zap Templates#

Lookup a user's Zap templates that they've added (published or draft). Note: We are limiting this endpoint to partners. This means that you will only see results for Zap templates that include your app in one of the steps.

URL Protected By Required Scopes
api.zapier.com/v1/zap-templates/me Client ID, Access Token templates

Arguments#

Available parameters to the Zap templates resource:

parameter requirement notes
client_id Required Your application client ID.
templates Optional A comma separated list of specific Zap templates.
apps Optional A comma separated list of Zapier Apps to match Zap templates against. Note: Your app will always be one of the apps.
limit Optional (defaults to 5, max of 100) Limit the number of Zap templates returned.
status Optional (defaults to published) Filter by specific status of a Zap template. Available statuses: draft and published.

Example Requests#

Get all Zap templates for my app.

curl -H "Authorization: Bearer {token}" -L "https://api.zapier.com/v1/zap-templates/me?client_id=${client_id}"

Get all Zap templates that include my app and another.

curl -H "Authorization: Bearer {token}" -L "https://api.zapier.com/v1/zap-templates?client_id=${client_id}&apps=mailchimp"

Get all Zap templates for my app that are draft.

curl -H "Authorization: Bearer {token}" -L "https://api.zapier.com/v1/zap-templates/me?client_id=${client_id}&status=draft"

EXAMPLE RESPONSE#

[{
  "description": "<p>Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.</p>\n\n<h2>How this Facebook Lead Ads-MailChimp integration works</h2>\n\n<ol>\n<li>Someone fills out one of your Facebook Lead Ads</li>\n<li>Zapier adds that individual to a specified list in MailChimp</li>\n</ol>\n\n<h2>Apps involved</h2>\n\n<ul>\n<li>Facebook Lead Ads</li>\n<li>MailChimp</li>\n</ul>\n",
  "title": "Subscribe new Facebook Lead Ad leads to a MailChimp list",
  "url": "https://zapier.com/zapbook/zaps/10127/subscribe-new-facebook-lead-ads-mailchimp-list/",
  "type": "guided_zap",
  "status": "published",
  "description_raw": "Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.\r\n\r\n## How this Facebook Lead Ads-MailChimp integration works\r\n\r\n1. Someone fills out one of your Facebook Lead Ads\r\n2. Zapier adds that individual to a specified list in MailChimp\r\n\r\n## Apps involved\r\n\r\n- Facebook Lead Ads\r\n- MailChimp",
  "slug": "subscribe-new-facebook-lead-ads-mailchimp-list",
  "description_plain": "Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.\n\nHow this Facebook Lead Ads-MailChimp integration works\n\nSomeone fills out one of your Facebook Lead Ads\n\nZapier adds that individual to a specified list in MailChimp\n\nApps involved\n\nFacebook Lead Ads\n\nMailChimp",
  "steps": [
    {
      "description": "Facebook lead ads make signing up for business information easy for people and more valuable for businesses. The Facebook lead ad app is useful for marketers who want to automate actions on their leads.",
      "title": "Facebook Lead Ads",
      "url": "https://zapier.com/zapbook/facebook-lead-ads/",
      "image": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.png",
      "api": "FacebookLeadsAPI",
      "slug": "facebook-lead-ads",
      "hex_color": "3b5998",
      "images": {
        "url_128x128": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.128x128.png",
        "url_64x64": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.64x64.png",
        "url_16x16": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.16x16.png",
        "url_32x32": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.32x32.png"
      },
      "id": 3535
    },
    {
      "description": "MailChimp is an email marketing service provider, founded in 2001. It has 6 million users that collectively send over 10 billion emails through the service each month.",
      "title": "MailChimp",
      "url": "https://zapier.com/zapbook/mailchimp/",
      "image": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.png",
      "api": "MailChimpAPI",
      "slug": "mailchimp",
      "hex_color": "239AB9",
      "images": {
        "url_128x128": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.128x128.png",
        "url_64x64": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.64x64.png",
        "url_16x16": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.16x16.png",
        "url_32x32": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.32x32.png"
      },
      "id": 6
    }
  ],
  "create_url": "https://zapier.com/partner/embed/facebook-lead-ads/create/10127",
  "id": 10127
}]

The Zap Template Object#

attribute type notes
create_url String An absolute URL used to create the Zap.
description String The HTML-rendered description provided when the Zap template was created.
description_plain String Plain text (HTML tags stripped) description. Note: \r and \n replaced with space character. Artifacts may be present.
description_raw String The [Markdown][markdown] description provided when the Zap template was created.
slug String A URL/SEO friendly ID for the Zap template.
steps Array An array of two or more steps in the Zap template. See below.
title String The name of the Zap template.
status String The status of the Zap template (choices: draft, published).
url String An absolute url to the Zapbook Zap template Page.
{
  "create_url": "https://zapier.com/partner/embed/facebook-lead-ads/create/10127",
  "description": "<p>Facebook Lead Ads are an...",
  "description_plain": "Facebook Lead Ads ... ",
  "description_raw": "**Facebook Lead Ads** are an ...",
  "slug": "subscribe-new-facebook-lead-ads-mailchimp-list",
  "status": "published",
  "steps": [{"... see App Object below ..."}],
  "title": "Subscribe new Facebook Lead Ad leads to a MailChimp list",
  "url": "https://zapier.com/zapbook/zaps/12084/subscribe-new-facebook-lead-ads-mailchimp-list/"
}

create_url and Prefill Options#

Always link the user with the create_url in order to create the Zap. Optionally, you can add additional parameters to the create_url so that the user's Zap is prefilled with the provided custom values. You will need to know the fields that your app requires per step.

One tip is to use the Zap template editor to find these fields.

Each parameter is in a flattened dictionary/object syntax. For example an object: {a: {b: 2}} would be flattened to: a__b=2. This allows you to provide countless prefills onbehalf of the user.

Example#

Prefill Trello's board ID (field: board) in the second step of the Zap template:

https://zapier.com/app/editor/template/2405?steps__1__params__board=12345

Here's what it would look like in the editor:

If you'd like to provide a label for the value (e.g. a Board's name) you can do so by passing an additional parameter:

https://zapier.com/app/editor/template/2405?steps__1__params__board=12345&steps__1__meta__parammap__board=My+Board

The App Object#

attribute type notes
description String Plain text description of the app.
hex_color String A Web Color Hex. Useful for icon/display background.
image String The app's logo in large format.
images Object Thumbnails for the app image.
Available sizes (and respective keys):
url_128x128, url_64x64, url_32x32, and url_16x16.
slug String A URL/SEO friendly ID for the app.
title String The name of the app.
url String An absolute url to the Zapbook Apps page.
{
  "description": "Facebook lead ads make signing up for business information ...",
  "hex_color": "3b5998",
  "image": "https://cdn.zapier.com/storage/s/fd9fef95169fd589d6cda992c0057cf8.png",
  "images": {
    "url_128x128": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.128x128.png",
    "url_16x16": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.16x16.png",
    "url_32x32": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.32x32.png",
    "url_64x64": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.64x64.png"
  },
  "slug": "facebook-lead-ads",
  "title": "Facebook Lead Ads",
  "url": "https://zapier.com/zapbook/facebook-lead-ads/"
}
↑ Was this documentation useful? Yes No

Changelog#

Date Resource Change
2017-11-01 All endpoints with access token protection After security review, the access tokens granted will no longer expire. This may change in the future, however, based on endpoints provided by the API. In that event, we expect API consumers to provide the user with the authorize endpoint to get a fresh access token.
2017-10-16 /zaps The endpoint will now return all Zaps regardless of the Zapier CLI App's version that was used when creating the Zap.
↑ Was this documentation useful? Yes No

Example Implementations#

See it in Action: How Unbounce Uses the API#

The API allows for so much flexibility that it can be challenging to picture the end result. Here's how lead generation app, Unbounce, built Zapier integrations into the Unbounce UI. The end result? A seamless integration experience for their users who can now connect their new Unbounce leads to hundreds of apps right from their Unbounce dashboard.

Now when Unbounce users are logged in, there's a slew of Zapier-powered integrations alongside their forms.

When a user chooses an integration, pop-up Zap Template guides the user through setting up that Zap, with info from Unbounce pre-filled like the form, client, landing page - anything already known about the Unbounce form. 

Then, once that Zap is set up and turned on, it's right there in Unbounce, where it can be edited, toggled on/off, etc. That means users can set up and manage nearly 1,000 integrations without ever leaving Unbounce.

Other Examples#

↑ Was this documentation useful? Yes No

Ready to Get Started?#

Request an API Key

↑ Was this documentation useful? Yes No
Get Help