Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zapier Zaps API

Refers to resources interacting with 'Zaps' associated resources

Zapier Zaps API is one of 13 APIs that Zapier publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Zaps. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 5 operations across 4 paths, and defines 32 schemas. It is described by OpenAPI 3.1.0, at version 2024.11.0.

Requests are made against a single base URL, https://api.zapier.com.

5 operations 4 paths 32 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2024.11.0
Base URL
https://api.zapier.com
Authentication
API Key, OAuth 2.0
Contact
Resource Areas
1

Authentication & Security 2

Zapier Zaps API declares 2 security schemes for authenticating requests. An API key is passed in the query as client_id (ClientIDAuthentication). It supports OAuth 2.0 (OAuth) using the authorizationCode and implicit flows, exposing 8 scopes.

  • ClientIDAuthentication — See our authentication documentation for how to find your Client ID
  • OAuth — See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Zaps 5

Refers to resources interacting with 'Zaps' associated resources

GET
/v1/zaps
Zapier Get Zaps [v1]
v1_zaps_list 4 params → 403401409429503504200
POST
/v2/guess
Zapier Guess a Zap [Beta]
create-zap-guess 1 param body → 200403401409429503504400
GET
/v2/zap-runs
Zapier Get Zap Runs
get-zap-runs 7 params → 200403401409429503504400
GET
/v2/zaps
Zapier Get Zaps [v2]
get-v2-zaps 5 params → 200403401409429503504400
POST
/v2/zaps
Zapier Create a Zap
post-zaps 1 param body → 201403401409429503504400

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Apps (10 properties), ZapStepApp (10 properties), ZapRun (9 properties), ExpandedZap (8 properties). Each schema is shown below with its type and property counts.

ZapRunStep
object
A single step in a Zap Run.
2 properties 1 required
ZapRun
object
A single Zap Run response.
9 properties 5 required
ExpandedZapsResponse
object
A page of returned Zaps.
3 properties 3 required
Error
object
Base Error definition
6 properties
ErrorResponse
object
1 property 1 required
Links
object
The links object returned in paginated response bodies.
2 properties
Zap
object
User Zaps.
6 properties 6 required
ZapTemplateStepImages
object
Images for a Zap Template at various sizes
4 properties 4 required
TypeOfEnum
string
read - read write - write filter - filter search - search searchorwrite - searchorwrite
ZapsResponse
object
A page of returned Zaps.
4 properties 4 required
ZapRequest
object
1 property 1 required
AuthenticationTypeEnum
string
authentication - authentication
ZapGuesserResponse
object
4 properties 3 required
ZapRunsResponse
object
A list of Zap Runs.
3 properties 2 required
ZapStepApp
object
Data for the App used in a given Zap's step
10 properties 10 required
ExpandedZapStep
object
An ordered list of steps that define the logic of the Zap.
4 properties 4 required
Category
object
Category an app belongs to.
1 property 1 required
ZapGuesserRawStep
object
3 properties 3 required
ExpandedZap
object
A Zap is an automated workflow that connects your apps and services together.
8 properties 7 required
Action
object
An Action is an operation that can be performed against a third-party API; either a read or a write. A Zap is composed of a read, followed by one or more write…
8 properties 8 required
CreateZapRequest
object
See our Building a Zap guide to get started.
2 properties 2 required
ErrorSource
object
Populates the source object inside our error responses.
3 properties
Authentication
object
An Authentication contains various fields, often credentials such as API tokens, used to access Partner APIs on behalf of a user. The actual fields are held se…
5 properties 5 required
ZapStep
object
One step in a Zap
3 properties 3 required
ActionTypeEnum
string
action - action
ZapGuesserRequest
object
1 property 1 required
ZapGuesserStep
object
2 properties 2 required
AppsImages
object
Images/icons of various resolutions to represent the app.
4 properties 4 required
CreateZapRequestStep
object
4 properties 3 required
InvalidZapGuesserResponse
object
1 property
BaseMeta
object
The meta object returned in paginated response bodies.
3 properties 2 required
Apps
object
An app that integrates with Zapier
10 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zapier-zaps-api-openapi.yml Raw ↑

Other APIs Zapier publishes across the network.

Zapier AI Actions API
Zapier MCP
Zapier Accounts API
Zapier Actions API
Zapier Apps API
Zapier Authentications API
Zapier Categories API
Zapier Experimental API
Zapier Inputs API
Zapier Outputs API
Zapier Zap Templates API