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

Refers to resources interacting with 'Actions' associated resources

Zapier Actions 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 Actions. 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 5 paths, and defines 33 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 5 paths 33 schemas 1 GET4 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 Actions 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 5 paths, the API surfaces 5 operations — 1 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Actions 5

Refers to resources interacting with 'Actions' associated resources

GET
/v2/actions
Zapier Get Actions
get-actions 2 params → 200403401409429503504400
POST
/v2/actions/{action_id}/inputs
Zapier Get Input Fields
get-fields-inputs 1 param body → 200403401409429503504400
POST
/v2/actions/{action_id}/inputs/{input_id}/choices
Zapier Get Choices
get-choices 3 params body → 200403401409429503504400
POST
/v2/actions/{action_id}/outputs
Zapier Get Output Fields
get-fields-outputs 1 param body → 200403401409429503504400
POST
/v2/actions/{action_id}/test
Zapier Step Test
test-action 1 param body → 200403401409429503504400

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are InputField (12 properties), Apps (10 properties), Action (8 properties), Error (6 properties). Each schema is shown below with its type and property counts.

OutputField
object
4 properties 3 required
Error
object
Base Error definition
6 properties
ActionTestResponse
object
Base Response definition to be used in other Response Serializers. Be sure to include the data field after using this class
3 properties 3 required
ChoiceResponse
object
A successful response for getting the requested Input Fields.
3 properties 2 required
Meta
object
Metadata about a certain response
1 property 1 required
ErrorResponse
object
1 property 1 required
Links
object
The links object returned in paginated response bodies.
2 properties
ActionsResponse
object
A valid response for fetching available actions for the App
3 properties 2 required
Choice
object
A single element from a set of Choices, variants in an enumeration.
4 properties 3 required
_ListInputFieldsRequest
object
The common data object that includes inputs and an authentication id.
2 properties 2 required
OutputFieldsResponse
object
A successful response containing Output Field data
3 properties 3 required
ListOutputFieldsRequest
object
1 property 1 required
_ListOutputFieldsRequest
object
The common data object that includes inputs and an authentication id.
3 properties 2 required
FieldsetFieldsField
Somewhat confusingly named, a field that is a list of either input fields or info fields.
InfoField
object
Represents an Info-type Fieldset
3 properties 3 required
Category
object
Category an app belongs to.
1 property 1 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
InputField
object
Represents Input Field data as accepted by the API
12 properties 12 required
ErrorSource
object
Populates the source object inside our error responses.
3 properties
ActionTypeEnum
string
action - action
InputFieldsResponse
object
A successful response for getting the input fields for a particular Action.
3 properties 3 required
ListInputFieldsRequest
object
Common inputs with inputs and an authentication id.
1 property 1 required
AppsImages
object
Images/icons of various resolutions to represent the app.
4 properties 4 required
FormatEnum
string
DATETIME - DATETIME MULTILINE - MULTILINE PASSWORD - PASSWORD CODE - CODE READONLY - READONLY FILE - FILE SELECT - SELECT
RootFieldset
array
The base concept of a Fieldset, from which others extend
ChoiceRequest
object
1 property 1 required
ValueTypeEnum
string
STRING - STRING NUMBER - NUMBER INTEGER - INTEGER BOOLEAN - BOOLEAN ARRAY - ARRAY OBJECT - OBJECT
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
_ActionTestRequest
object
The request structure to test a particular Action
4 properties 2 required
ChoiceParams
object
A Choice as to be provided to the /choices endpoint
2 properties 2 required
ActionTestRequest
object
1 property 1 required
Fieldset
object
Represents a Fieldset
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zapier-actions-api-openapi.yml Raw ↑

Other APIs Zapier publishes across the network.

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