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 Experimental API

Refers to resources interacting with 'Experimental' associated resources

Zapier Experimental 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 Experimental. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 21 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.

4 operations 4 paths 21 schemas 3 GET1 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 Experimental 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 4

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

Experimental 4

Refers to resources interacting with 'Experimental' associated resources

POST
/v2/action-runs
Zapier Create an Action Run
create-action-run body → 200403401409429503504400
GET
/v2/action-runs/{id}
Zapier Retrieve Action Run
retrieve-action-run 1 param → 200403401409429503504400
GET
/v2/whitelabel/apps
Zapier Get Whitelabel Apps [v2]
v2-whitelabel-apps-list 4 params → 403401409429503504400500
GET
/v2/zap-runs
Zapier Get Zap Runs
get-zap-runs 7 params → 200403401409429503504400

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ZapRun (9 properties), WhitelabelApp (8 properties), Error (6 properties), _ActionRunResponseError (5 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
RunTypeEnum
string
run - Run
_ActionRunResponse
object
4 properties 3 required
ZapRun
object
A single Zap Run response.
9 properties 5 required
WhitelabelApp
object
An app available for whitelabel connection.
8 properties 8 required
Error
object
Base Error definition
6 properties
ErrorResponse
object
1 property 1 required
CodeEnum
string
user - user authentication - authentication partner - partner system - system throttled - throttled systemthrottled - systemthrottled hydration - hydration
Links
object
The links object returned in paginated response bodies.
2 properties
RunActionResponse
object
1 property 1 required
_RunActionResponse
object
The response after an Action Run
2 properties 2 required
WhitelabelAppsResponse
object
A JSON:API-style response of apps available for whitelabel connection.
3 properties 3 required
WhitelabelAppLinks
object
2 properties 2 required
ZapRunsResponse
object
A list of Zap Runs.
3 properties 2 required
ActionRunResponse
object
The response of a given Action Run
1 property 1 required
ErrorSource
object
Populates the source object inside our error responses.
3 properties
_RunActionRequest
object
3 properties 3 required
_ActionRunResponseStatusEnum
string
success - success error - error waiting - waiting
_ActionRunResponseError
object
The error information returned from a third party when running an action.
5 properties
BaseMeta
object
The meta object returned in paginated response bodies.
3 properties 2 required
RunActionRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zapier-experimental-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 Inputs API
Zapier Outputs API
Zapier Zap Templates API
Zapier Zaps API