v1

latestOpenAPI 3.1.02026-07-2631111195.5 KB
Zaps

Get Zaps [v2]

This endpoint returns a list of Zaps for the authenticated Zapier user.

The expand array can be used to expand selected fields into full objects in the response. Inputs with keys can also be passed to filter Zaps by certain criteria.

Scope Selection:

  • Use zap if you have a Zapier integration and wish to get only Zaps using your integration.
  • Use zap:all to get all of the user's Zaps.
  • Use zap:account:all to get all of the Zaps the user has access to in their account.

When using OAuth

This endpoint requires the zap, zap:all, or zap:account:all OAuth scopes.

get/v2/zaps

Query parameters

expandstring

A comma separated list of Zap fields that should be expanded from ids to full objects in the response. Fields that may not be expanded will remain as ids.

include_sharedboolean

If true, all Zaps that are shared with the user, rather than only those owned by them, are returned. If the zap:account:all scope is not present this has no effect.

inputsstring

You may pass inputs[KEY]=VALUE1,VALUE2 to filter for Zaps that contain those settings. Keys are defined by your app on the developer platform.

limitinteger

Used for paginating results. Specifies the maximum number of items to return per page. If this value is not set, it defaults to 10.

offsetinteger

Used for paginating results. Specifies the offset to use.

Response

linksobject required

Links related to the response data

metaobject required

Metadata about the response