> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zapier

> How to set up the Zapier connector, plus the actions that are available.

![Zapier](https://stackone-logos.com/api/zapier/filled/svg)

Betav0.3.0[See changelog](https://docs.stackone.com/connectors/zapier/changelog.md)

[37 actions](#actions) · 3 auth methods

Automation
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [SCIM API Token · Connector Profile](https://docs.stackone.com/connectors/zapier/guides/connector-profile/scim-api-token.md)
>
> Uses the SCIM API token Zapier generates when user provisioning is enabled, the same token an identity provider uses if...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/zapier/guides/connector-profile/oauth-2-0.md)
>
> Requires a Zapier integration published as a public integration in the App Directory, with its client ID, secret and red...

> [card] [OAuth 2.0 - Client Credentials · Connector Profile](https://docs.stackone.com/connectors/zapier/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> App-level access with an app access token, not tied to a user, for unenrolling accounts from promotions and for catalog...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [SCIM API Token · Link Account](https://docs.stackone.com/connectors/zapier/guides/link-account/scim-api-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/zapier/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 - Client Credentials · Link Account](https://docs.stackone.com/connectors/zapier/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

OAuth 2.0 - Client Credentials

SCIM API Token

No auth methods found

Scopes

Select all
|
Clear

action:run

connection:delete

connection:read

connection:write

profile

promotions:read

promotions:write

zap

zap:delete

zap:pause

zap:runs

zap:update

zap:write

No scopes found

37 actions

ActionDescriptionRequired scopes

Create Action Run`zapier_create_action_run`

Run an app action once outside a Zap

`action:run`

Get Action Run`zapier_retrieve_action_run`

Get the status and results of an action run

`action:run`

List Actions`zapier_get_actions`

List the triggers and actions an app offers

Get Input Choices`zapier_get_choices`

Get the allowed values for a dropdown input field of an action

`zap`

Test Action Step`zapier_test_action`

Run a test of an action step with the given inputs

`zap:write`

List Apps`zapier_get_v2_apps`

List or search apps in the Zapier App Directory

Get Apps V1`zapier_get_apps_v1`

List apps in the Zapier App Directory sorted by popularity

List Authentications`zapier_get_authentications`

List the user's connected app authentications for an app

`connection:read`

Create Authentication`zapier_create_authentication`

Create a connected app authentication from credential fields

`connection:write`

Delete Authentication`zapier_delete_authentication`

Delete a connected app authentication

`connection:delete`

Get Categories`zapier_get_categories`

List Zapier app categories

List Groups`zapier_list_groups`

List groups in the connected Zapier account through the SCIM API.

Get Group`zapier_get_group`

Get a single Zapier group by SCIM ID.

List Unified Groups`zapier_unified_list_groups`

List unified groups in the connected Zapier account.

Get Unified Group`zapier_unified_get_group`

Get a unified Zapier group by ID.

List Unified Users`zapier_unified_list_users`

List unified users in the connected Zapier account.

Get Unified User`zapier_unified_get_user`

Get a unified Zapier user by ID.

Get Input Fields`zapier_get_fields_inputs`

Get the input fields of an action

`zap:write`

Get Output Fields`zapier_get_fields_outputs`

Get the output fields an action produces

`zap:write`

Create Promotion Enrollment`zapier_create_promotion_enrollment`

Enroll the connected Zapier account in a partner promotion

`promotions:write`

Get Promotion Enrollment`zapier_get_promotion_enrollment`

Get the status and task usage of a promotion enrollment

`promotions:read`

Delete Promotion Enrollment`zapier_delete_promotion_enrollment`

Unenroll an account from a promotion

`promotions:write`

Get Service Provider Config`zapier_get_service_provider_config`

Get the SCIM configuration of the connected Zapier account.

Get Schemas`zapier_get_schemas`

Get how Zapier formats SCIM users or groups.

List Users`zapier_list_users`

List users in the connected Zapier account through the SCIM API.

Get User`zapier_get_user`

Get a single Zapier user by SCIM ID.

List Zap Runs`zapier_get_zap_runs`

List Zap run history with status and date filters

`zap:runs`

Get User Profile`zapier_get_current_user_profile`

Get the profile of the authenticated Zapier user

`profile`

Guess Zap`zapier_guess_zap`

Suggest a Zap and a pre-filled Zapier URL from a plain-language description (beta)

List Zaps`zapier_get_v2_zaps`

List the Zaps of the authenticated user

`zap`

Create Zap`zapier_create_zap`

Create a Zap from a title and an ordered list of steps

`zap:write`

Update Zap`zapier_update_zap`

Edit a Zap title or replace its steps

`zap:update`

Delete Zap`zapier_delete_zaps`

Permanently remove a Zap and its configuration by id, which cannot be undone

`zap:delete`

Disable Zap`zapier_disable_zaps`

Turn a Zap off without deleting it

`zap:pause`

Enable Zap`zapier_enable_zaps`

Turn a Zap on by republishing its current version

`zap:pause`

Get Zaps V1`zapier_get_zaps_v1`

List the authenticated user's Zaps with your app's step params

`zap`

Get Zap Templates`zapier_get_zap_templates`

List popular Zap templates for your integration


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.