Create Account

Create a new user and obtain an access token. See our Quick Account Creation guide to get started.

GET /v2/authorize

Create Account

cURL

curl --request GET \
  --url 'https://api.zapier.com/v2/authorize?client_id='

400

{
  "errors": [
    {
      "status": 400,
      "code": "parse_error",
      "title": "ParseError",
      "detail": "Malformed request.",
      "source": null,
      "meta": {
        "source": "ZAPIER",
        "full_details": {
          "message": "Malformed request.",
          "code": "parse_error"
        }
      }
    }
  ]
}

⚠️ This is not a regular API endpoint that returns JSON.

👉 It is a flow that includes account creation and OAuth authorization.

This URL should be opened in a popup window. See the Quick Account Creation page for more information about allowing your customers to sign up for Zapier easily.

Main page example

Start with this example code in order to build a correct /v2/authorize API call in a well-sized popup window and await the completion of the flow. Then you can use the other API endpoints to retrieve your needed information.

zapier.js

/**
 * Ensure the user has a Zapier account and has authorized this
 * site to access it. If not, a log in form or sign up form
 * will be shown to the user along the way.
 *
 * @param {Object} options
 * @param {String} options.clientId - The OAuth client ID
 * @param {String} options.signUpEmail - The user's email to use for pre-filling the sign up form.
 * @param {String} options.signUpFirstName - The user's first name to use for pre-filling the sign up form.
 * @param {String} options.signUpLastName - The user's last name to use for pre-filling the sign up form.
 */
export async function zapierAuthorize(options) {
  const root = "https://api.zapier.com";
  const url = new URL("/v2/authorize", root);
  const params = url.searchParams;
  params.set("client_id", options.clientId);
  params.set("redirect_uri", location.href);
  params.set("response_type", "code");
  const scopes = ["zap", "profile"];
  params.set("scope", scopes.join(" "));
  //
  // These parameters are optional but highly recommended.
  // Users will receive a prefilled sign up form,
  // allowing them to continue with a single click
  // (or edit the values).
  //
  params.set("sign_up_email", options.signUpEmail);
  params.set("sign_up_first_name", options.signUpFirstName);
  params.set("sign_up_last_name", options.signUpLastName);

  // Navigate to the /v2/authorize API, which will eventually
  // redirect back to `location.href` but with `?code=<CODE>`
  // in the URL parameters. At this point you will need to
  // exchange the OAuth code for an OAuth token.
  const popup = window.open(
    url.href,
    // If you give an opened window a name, it will prevent there
    // from being more than one window open at the same time with
    // that name. The new URL supplied to `open` will navigate
    //  existing window.
    "zapier-authorize",
    // Ensure a comfortable amount of space in the popup
    "width=1024,height=1280",
  );
  if (!popup) {
    alert("Failed to open popup window. Please allow popups and try again.");
  }
  const data = await waitForPopupClose(popup);
}

/**
 * Waits for the given popup window to close,
 * or for it to send a message that passes the `callback` function supplied.
 *
 * @param {Window} popup - The popup window created by `window.open`
 */
async function waitForPopupClose(popup) {
  return await new Promise((resolve) => {
    function onMessage(event) {
      if (
        typeof event.data === "object" &&
        event.data &&
        event.data.type === "zapier.popup.close"
      ) {
        popup.close();
        finishAndCleanUp(event.data);
      } else {
        console.warn("unhandled message event: (data)", event.data);
      }
    }
    function finishAndCleanUp() {
      resolve(undefined);
      removeEventListener("message", onMessage);
      clearInterval(interval);
    }
    // Wait for `postMessage` event
    addEventListener("message", onMessage);
    // Wait for popup to be closed if the message wasn't received
    const interval = setInterval(() => {
      if (popup.closed) {
        // The interval may have run after the popup closed and before onMessage
        // had a chance to process messages. This prevents a frequent race
        // condition in Firefox, where finishAndCleanUp was called here before
        // onMessage could call finishAndCleanUp.
        setTimeout(() => {
          finishAndCleanUp(undefined);
        });
      }
    });
  });
}

Redirect URI page example

The redirect URI page must exchange the OAuth code for an OAuth token within 2 minutes. The resulting token MAY NOT be stored in an insecure manner. The suggested location is in your application’s database, in a data model for the current user.

See the OAuth 2.0 Token Exchange RFC for more detail.

const url = new URL(request.url);
const code = url.searchParams.get("code");
const token = await EXCHANGE_CODE_FOR_TOKEN(code);
await SAVE_TOKEN_TO_DATABASE(CURRENT_USER_ID, token);

Authorizations

client_id · string · query · required

See our authentication documentation for how to find your Client ID

Query Parameters

client_id · string · required

Your application Client ID.

Minimum string length: 1

redirect_uri · string · required

The page the user will be redirect to after OAuth flow.

Minimum string length: 1

referer · string

Minimum string length: 1

response_type · string · required

Only OAuth response type code is supported

Minimum string length: 1

scope · string · required

Space (%20) separated values

Minimum string length: 1

sign_up_email · string<email>

Email of the user signing up.

Minimum string length: 1

sign_up_first_name · string

First name of the user signing up.

Minimum string length: 1

sign_up_last_name · string

Last name of the user signing up.

Minimum string length: 1

utm_campaign · string · default: workflow_api

Minimum string length: 1

utm_content · string

Minimum string length: 1

utm_medium · string · default: embed

Minimum string length: 1

utm_source · string · default: partner

Minimum string length: 1

Response

302

Redirect to authorization URL