openapi.city
Sign in

Zapier Embed

Embedded integration platform

zapier.com/developer ↗
Version
1.0.0
OpenAPI
3.0.3
Endpoints
11
Schemas
46
Updated
3 days ago
Automation automation integration embedding
Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.zapier.com/v2

Authentication

oauth2

Endpoints

GET POST PUT PATCH DELETE

Actions 5 endpoints

GET /actions

Fetch the available actions for the provided App. It's typical to filter by type so that only actions that make sense for a particular step are shown. For example only showing reads for the first step in a Zap. This endpoint requires the `zap` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Actions_listAvailableActions

Parameters

Name In Required Type Description
optional
optional

Responses

default
200 A valid response for fetching available actions for the App.
404
406
415
GET /actions
POST /actions/{action}/inputs

Get the Input Fields for a particular Action, using the provided authentication and inputs. This endpoint requires the `zap:write` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Actions_getInputFields

Request Body

{
  "$ref": "#/components/requestBodies/Inputs",
  "examples": {
    "Example 1": {
      "value": {
        "limit": 10,
        "inputs": {
          "deal_pipeline": "My Awesome Pipeline"
        },
        "offset": 0,
        "authentication": "b3eYnwl"
      }
    }
  }
}

Responses

default
200 A successful response for getting the input fields for a particular Action.
404
406
415
POST /actions/{action}/inputs
POST /actions/{action}/inputs/{input}/choices

Get the possible values for an Input Field that is marked as `SELECT`. This endpoint requires the `zap` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Actions_getChoices

Parameters

Name In Required Type Description
page query optional string The page of choices to return, defaults to the first

Request Body

{
  "content": {
    "application/vnd.api+json": {
      "schema": {
        "$ref": "#/components/schemas/ActionsGetChoicesRequest"
      }
    }
  },
  "description": ""
}

Responses

default
200 A successful response for getting the requested Input Fields.
404
406
415
POST /actions/{action}/inputs/{input}/choices
POST /actions/{action}/outputs

Get the Output Fields for a particular Action, using the provided authentication and inputs. This endpoint requires the `zap:write` OAuth scope. This API is rate limited by IP address (60 requests per min).

operationId: Actions_getOutputFields

Request Body

{
  "$ref": "#/components/requestBodies/Outputs",
  "examples": {
    "Example 1": {
      "value": {
        "limit": 10,
        "inputs": {
          "deal_pipeline": "My Awesome Pipeline"
        },
        "offset": 0,
        "authentication": "b3eYnwl",
        "fetch_live_samples": true
      }
    }
  }
}

Responses

default
200 A successful request to get the Output Fields for an Action.
404
406
415
POST /actions/{action}/outputs
POST /actions/{action}/test

Tests the action (step) in the third party api, using the provided authentication and inputs. On a successful test returns 200 and the result of executing the action, otherwise it returns a 400 and details about the failure. This endpoint requires the `zap:write` OAuth scope. This API is rate limited by IP address (60 requests per min).

operationId: Actions_testActionExecution

Request Body

{
  "$ref": "#/components/requestBodies/TestAction"
}

Responses

200 OK
404
406
POST /actions/{action}/test

Apps 1 endpoints

GET /apps

This endpoint returns a list of popular apps. Keep in mind that Zapier built-in apps will not be returned and the order of the result is by app popularity. This endpoint requires the `zap` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Apps_listPopular

Parameters

Name In Required Type Description
limit query optional integer Used for paginating results. Specifies the amount of apps to return.
offset query optional integer Used for paginating results. Specifies the offset of the apps to return.
category query optional string Categories that apps must have in order to be returned in the response. E.g. Accounting (`accounting`), AI Tools (`ai-tools`), and All (`all`). The full list of valid categories can be retrieved using the `category` endpoint, detailed [here](https://platform.zapier.com/embed/partner-api#get-v1categories).
query query optional string Parameter to limit the results to apps whose titles match the provided query.
ids query optional string Parameter to restrict the results to apps whose ID matches those in the provided comma-separated value. Cannot be combined with `category`.

Responses

default
200 OK
401 Unauthorized
GET /apps

Authentications 2 endpoints

GET /authentications

Fetch the available Authentications for the provided App. This will only return Authentications that are owned by the user and not those that are shared with them, since it''s not possible to create Zaps with Authentications you don''t own. This endpoint requires the `authentication` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Authentications_getAvailable

Parameters

Name In Required Type Description
optional
optional
optional

Responses

default
200 A successful request to get available Authentications for the provided App.
404
406
415
GET /authentications
POST /authentications

Creates a new Authentication for the provided App. This endpoint requires the `authentication:write` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Authentications_createNewAuthentication

Request Body

{
  "content": {
    "application/vnd.api+json": {
      "schema": {
        "$ref": "#/components/schemas/AuthenticationsCreateNewAuthenticationRequest"
      }
    }
  },
  "required": true,
  "description": "Inputs to create a new Authentication"
}

Responses

default
201 A successful response to create a new Authentication
406
415
POST /authentications

Experimental 1 endpoints

GET /zap-runs

This endpoint is a first version tool that delivers basic yet essential details about their executed Zap runs. As an evolving interface, this first version serves foundational information about Zap runs. _However, it's important to note that this is an initial implementation and the **response payload is not definitive**. Our aim is to continually iterate and enhance this API, refining its capabilities and data output, to progressively deliver more valuable and useful information in future versions._ This endpoint requires the `zap:runs` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first. Please note that since this is an experimental tool, if you're interested in gaining access, you must contact our support team.

operationId: Experimental_getZapRuns

Parameters

Name In Required Type Description
from_date query optional string Find Zap runs equal to or newer than this date. If not provided, results default to last 30 days' Zap Runs.
to_date query optional string Find Zap runs less than this date.
zap_id query optional string Find Zap runs for the specified Zap ID.
limit query optional integer Maximum number of returned Zap Runs.
offset query optional integer Number of Zap Runs to skip.
search query optional string Performs a text search against the `zap_title`, `data_in`, and `data_out` fields, returning only zap runs that match the specified keywords.
statuses query optional string Accepts one or more status values separated by commas, enabling the filtering of zap runs based on the specified status or statuses provided.

Responses

200 OK
401 Unauthorized
403 Forbidden
GET /zap-runs

Zaps 2 endpoints

GET /zaps

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. This endpoint requires the `zap` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Zaps_getFilteredZaps

Parameters

Name In Required Type Description
limit query optional integer Used for paginating results. Specifies the amount of apps to return
offset query optional integer Used for paginating results. Specifies the offset of the apps to return
inputs query optional object You may pass inputs[KEY]=VALUE1,VALUE2 to filter for Zaps that contain those settings. For example, if your OAuth app is Trello you may filter for Zaps that contain a certain Trello board using inputs[board]=BOARD_ID — Keys are defined by your app on the developer platform.
expand query optional string A comma separated list of Zap fields that should be expanded from ids to full objects in the response. If a field may not be expanded, its encoded form will be returned instead.

Responses

default
200 OK
401 Unauthorized
403 Forbidden
GET /zaps
POST /zaps

This URL creates a new Zap based on a series of steps and a given title. `is_enabled` must be set to true when creating a new Zap. This endpoint requires the `zap:write` OAuth scope. This API is rate limited by IP address (60 requests per min), or partner (150 requests per min), whichever occurs first.

operationId: Zaps_createZap

Parameters

Name In Required Type Description
expand query optional string A comma separated list of Zap fields that should be expanded from ids to full objects in the response. If a field may not be expanded, its encoded form will be returned instead.

Request Body

{
  "content": {
    "application/vnd.api+json": {
      "schema": {
        "$ref": "#/components/schemas/ZapsCreateZapRequest"
      }
    }
  },
  "description": ""
}

Responses

default
201 Created
POST /zaps

Schemas

object Action 
{
  "type": "object",
  "title": "Action",
  "example": {
    "id": "uag:1f188536-6dd0-4172-8414-2b90914ddee9X",
    "app": "83b47c0e-adda-44da-a45d-42565fe521ef",
    "key": "new_lead",
    "type": "action",
    "title": "New Lead",
    "is_instant": false,
    "action_type": "READ",
    "description": "Triggers when a new lead is added to SuperExampleCRM"
  },
  "required": [
    "type",
    "id",
    "key",
    "action_type",
    "app",
    "description",
    "is_instant",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "uag:1f188536-6dd0-4172-8414-2b90914ddee9",
      "pattern": "^[\\w-]+:[\\w-]+$",
      "x-stoplight": {
        "id": "13o2l55kldo76"
      }
    },
    "app": {
      "oneOf": [
        {
          "type": [
            "string"
          ],
          "format": "uuid",
          "example": "83b47c0e-adda-44da-a45d-42565fe521ef",
          "description": "The id of the app associated with this action."
        },
        {
          "$ref": "#/components/schemas/App",
          "description": "The full app associated with this action.",
          "x-stoplight": {
            "id": "rvaekq661wgle"
          }
        }
      ],
      "description": "Expandable field for app.",
      "x-stoplight": {
        "id": "u8nmq10dwcr51"
      }
    },
    "key": {
      "type": "string",
      "example": "new_lead",
      "description": "The developer provided identifier for this Action.",
      "x-stoplight": {
        "id": "65d0qb3nozmz3"
      }
    },
    "type": {
      "type": "string",
      "const": "action",
      "readOnly": true,
      "description": "The type of this object."
    },
    "title": {
      "type": "string",
      "example": "New Lead",
      "description": "The title of this Action.",
      "x-stoplight": {
        "id": "8cjkleeohsp4c"
      }
    },
    "is_instant": {
      "type": "boolean",
      "description": "Will be set to `true` if this Action triggers instantly. May only be `true` when `type` is `READ`.",
      "x-stoplight": {
        "id": "xey6l2w9qt818"
      }
    },
    "action_type": {
      "enum": [
        "READ",
        "WRITE"
      ],
      "type": "string",
      "example": "READ",
      "description": "The type of this Action.",
      "x-stoplight": {
        "id": "upjghxsarpry4"
      }
    },
    "description": {
      "type": "string",
      "example": "Triggers when a new lead is added to SuperExampleCRM",
      "description": "A longer description of this Action, usually describing what it does in more detail.",
      "x-stoplight": {
        "id": "p1x8q39uuar4o"
      }
    }
  },
  "x-examples": [
    {
      "id": "uag:1f188536-6dd0-4172-8414-2b90914ddee9X",
      "app": "83b47c0e-adda-44da-a45d-42565fe521ef",
      "key": "new_lead",
      "type": "action",
      "title": "New Lead",
      "is_instant": false,
      "action_type": "READ",
      "description": "Triggers when a new lead is added to SuperExampleCRM"
    },
    {
      "id": "uag:1f188536-6dd0-4172-8414-2b90914ddea7",
      "app": "83b47c0e-adda-44da-a45d-42565fe521ef",
      "key": "new_deal",
      "type": "action",
      "title": "New Deal",
      "is_instant": false,
      "action_type": "READ",
      "description": "Triggers when a new deal is created."
    },
    {
      "id": "uag:1f188536-6dd0-4172-8414-2b90914ddea7",
      "app": {
        "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaa",
        "type": "app",
        "image": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
        "links": {
          "connect_new_authentication": "https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
        },
        "title": "HubSpot",
        "images": {
          "url_16x16": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
          "url_32x32": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
          "url_64x64": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
          "url_128x128": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
        },
        "hex_color": "8bcbca",
        "categories": [
          {
            "slug": "marketing-automation"
          }
        ],
        "description": "HubSpot is your all-in-one stop for all of your marketing software needs."
      },
      "key": "new_deal",
      "type": "action",
      "title": "New Deal",
      "is_instant": true,
      "action_type": "READ",
      "description": "Triggers when a new deal is created."
    }
  ],
  "x-internal": false,
  "description": "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 writes.",
  "x-stoplight": {
    "id": "08691ffzj6wm3"
  }
}
object ActionsGetChoicesRequest 
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "authentication"
      ],
      "properties": {
        "inputs": {
          "type": "object"
        },
        "authentication": {
          "type": "string"
        }
      }
    }
  },
  "x-examples": {
    "Example 1": {
      "data": {
        "inputs": {
          "worksheet": "123_nKsdw34"
        },
        "authentication": "J2PlD7Rt"
      }
    }
  }
}
object ActionsGetChoicesResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Choice"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/MetaWithPage"
    },
    "links": {
      "$ref": "#/components/schemas/LinksWithPage",
      "x-stoplight": {
        "id": "b7vo65yrboxrv"
      }
    }
  }
}
object ActionsGetInputFieldsRequest 
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InputsWithAuthenticationId",
      "x-stoplight": {
        "id": "k2qnaa3i5c3qb"
      }
    }
  }
}
object ActionsGetInputFieldsResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/Input-Field",
            "x-stoplight": {
              "id": "aa89vbos7u7bt"
            }
          },
          {
            "$ref": "#/components/schemas/Fieldset",
            "x-stoplight": {
              "id": "hhdrvc5sgwy4m"
            }
          },
          {
            "$ref": "#/components/schemas/Info-Field",
            "x-stoplight": {
              "id": "22g4l4bd4w92z"
            }
          }
        ],
        "x-stoplight": {
          "id": "oqly4mdn0oahi"
        }
      },
      "x-stoplight": {
        "id": "d12jbgm654li9"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    }
  }
}
object ActionsGetOutputFieldsRequest 
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InputsWithAuthenticationIdAndFetchLiveSamples",
      "x-stoplight": {
        "id": "yi2s3ggfutlr0"
      }
    }
  }
}
object ActionsGetOutputFieldsResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Output-Field"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    }
  }
}
object ActionsListAvailableActions404Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error"
      }
    }
  }
}
object ActionsListAvailableActions406Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error"
      }
    }
  }
}
object ActionsListAvailableActions415Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error"
      }
    }
  }
}
object ActionsListAvailableActionsResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Action",
        "x-stoplight": {
          "id": "08691ffzj6wm3"
        }
      },
      "x-stoplight": {
        "id": "y66uevss99ldk"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    }
  }
}
object ActionsListAvailableActionsdefaultResponse 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error",
        "x-stoplight": {
          "id": "h3ihokmwh1x4o"
        }
      }
    }
  }
}
object ActionsTestActionExecution200Response 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "x-stoplight": {
          "id": "x26i0e55dyp02"
        }
      },
      "x-stoplight": {
        "id": "qlbm0e8jqc3ly"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta",
      "x-stoplight": {
        "id": "npiau31y6oeeh"
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links",
      "x-stoplight": {
        "id": "zhn4igtrkhlyx"
      }
    }
  }
}
object ActionsTestActionExecutionRequest 
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/InputsWithAuthenticationIdNoPage",
      "x-stoplight": {
        "id": "d4ph7lebgpk9p"
      }
    }
  }
}
object ActionsTestActionExecutionResponse 
{
  "type": "object",
  "properties": {
    "": {
      "type": "string",
      "x-stoplight": {
        "id": "m15m1mdsk7bvc"
      }
    }
  }
}
object App 
{
  "type": "object",
  "title": "App",
  "example": {
    "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaaX",
    "type": "app",
    "image": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
    "links": {
      "connect_new_authentication": "https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
    },
    "title": "HubSpot",
    "images": {
      "url_16x16": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
      "url_32x32": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
      "url_64x64": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
      "url_128x128": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
    },
    "hex_color": "8bcbca",
    "categories": [
      {
        "slug": "marketing-automation"
      }
    ],
    "description": "HubSpot is your all-in-one stop for all of your marketing software needs."
  },
  "required": [
    "type",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaa",
      "description": "Unique id of the app"
    },
    "type": {
      "type": "string",
      "const": "app",
      "readOnly": true,
      "description": "The type of this object."
    },
    "image": {
      "type": "string",
      "format": "uri",
      "example": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
      "description": "Default image/icon to represent the app."
    },
    "links": {
      "type": "object",
      "properties": {
        "connect_new_authentication": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri",
          "example": "https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect",
          "description": "A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.\n\nIf value is `null`, then no authentication is required to use the app.",
          "x-stoplight": {
            "id": "lkvty8v9do3ot"
          }
        }
      }
    },
    "title": {
      "type": "string",
      "example": "HubSpot",
      "description": "Human readable name of the app"
    },
    "images": {
      "type": "object",
      "properties": {
        "url_16x16": {
          "type": "string",
          "format": "uri",
          "example": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16"
        },
        "url_32x32": {
          "type": "string",
          "format": "uri",
          "example": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32"
        },
        "url_64x64": {
          "type": "string",
          "format": "uri",
          "example": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64"
        },
        "url_128x128": {
          "type": "string",
          "format": "uri",
          "example": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
        }
      },
      "description": "Images/icons of various resolutions to represent the app."
    },
    "hex_color": {
      "type": "string",
      "example": "8bcbca",
      "pattern": "^([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
      "description": "A branded color that can be used to represent the app.",
      "x-stoplight": {
        "id": "9zj29g5ib8afy"
      }
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "example": "marketing-automation"
          }
        },
        "x-stoplight": {
          "id": "zul06vozqt2gq"
        }
      },
      "description": "A list of categories to which this app belongs. Helpful in identifying apps by type and functionality."
    },
    "description": {
      "type": "string",
      "example": "HubSpot is your all-in-one stop for all of your marketing software needs.",
      "description": "Human readable description of the app."
    }
  },
  "x-examples": [
    {
      "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaaX",
      "type": "app",
      "image": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
      "links": {
        "connect_new_authentication": "https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
      },
      "title": "HubSpot",
      "images": {
        "url_16x16": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
        "url_32x32": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
        "url_64x64": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
        "url_128x128": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
      },
      "hex_color": "8bcbca",
      "categories": [
        {
          "slug": "marketing-automation"
        }
      ],
      "description": "HubSpot is your all-in-one stop for all of your marketing software needs."
    },
    {
      "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbbb",
      "type": "app",
      "image": "https://zapier-images.imgix.net/storage/developer/a70589f8db6a514b6820267b506409f0.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
      "links": {
        "connect_new_authentication": "https://zapier.com/engine/auth/start/slackAPI?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
      },
      "title": "Pipedrive",
      "images": {
        "url_16x16": "https://zapier-images.imgix.net/storage/developer/a70589f8db6a514b6820267b506409f0.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
        "url_32x32": "https://zapier-images.imgix.net/storage/developer/a70589f8db6a514b6820267b506409f0.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
        "url_64x64": "https://zapier-images.imgix.net/storage/developer/a70589f8db6a514b6820267b506409f0.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
        "url_128x128": "https://zapier-images.imgix.net/storage/developer/a70589f8db6a514b6820267b506409f0.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
      },
      "hex_color": "414143",
      "categories": [
        {
          "slug": "crm"
        }
      ],
      "description": "Pipedrive is sales pipeline and CRM software for deal makers. Get super-organized. Close deals in less time. iOS and Android apps let you take your pipeline with you anywhere."
    }
  ],
  "description": "An app that integrates with Zapier.",
  "x-stoplight": {
    "id": "vuqdljvf1dkfx"
  }
}
object AppsListPopular401Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error",
        "x-stoplight": {
          "id": "l58vecxneaykz"
        }
      },
      "x-stoplight": {
        "id": "vdmg3yluafenr"
      }
    }
  }
}
object AppsListPopularResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/App",
        "x-stoplight": {
          "id": "vuqdljvf1dkfx"
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    }
  }
}
object Authentication 
{
  "type": "object",
  "title": "Authentication",
  "example": {
    "id": "b3eYnwlX",
    "app": "b61ae76e-487b-4622-8679-df3d3e20bccc",
    "type": "authentication",
    "title": "SuperExampleCRM (example@zapier.com)",
    "is_expired": false
  },
  "required": [
    "type",
    "id",
    "app",
    "is_expired",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "b3eYnwl",
      "pattern": "^\\w+",
      "x-stoplight": {
        "id": "vjo26hmiyyinb"
      }
    },
    "app": {
      "oneOf": [
        {
          "type": "string",
          "format": "uuid",
          "example": "b61ae76e-487b-4622-8679-df3d3e20bccc",
          "behavior": "Read Only",
          "x-stoplight": {
            "id": "dbhhro3x7miu4"
          }
        },
        {
          "$ref": "#/components/schemas/App",
          "x-stoplight": {
            "id": "896tsg3z0cxtd"
          }
        }
      ],
      "x-stoplight": {
        "id": "grmncgmkbdbv9"
      }
    },
    "type": {
      "type": "string",
      "const": "authentication",
      "readOnly": true,
      "description": "The type of this object."
    },
    "title": {
      "type": "string",
      "example": "SuperExampleCRM (example@zapier.com)",
      "x-stoplight": {
        "id": "9hh287r6y8kc5"
      }
    },
    "is_expired": {
      "type": "boolean",
      "readOnly": true,
      "description": "If `true`, this Authentication has expired. It will not be usable, and the user needs to be directed to reconnect it.",
      "x-stoplight": {
        "id": "5upf21yg6jvup"
      }
    }
  },
  "x-examples": [
    {
      "id": "b3eYnwlX",
      "app": "b61ae76e-487b-4622-8679-df3d3e20bccc",
      "type": "authentication",
      "title": "SuperExampleCRM (example@zapier.com)",
      "is_expired": false
    },
    {
      "id": "BRn9rRg",
      "app": {
        "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaa",
        "type": "app",
        "image": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
        "links": {
          "connect_new_authentication": "https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
        },
        "title": "HubSpot",
        "images": {
          "url_16x16": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
          "url_32x32": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
          "url_64x64": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
          "url_128x128": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
        },
        "hex_color": "8bcbca",
        "categories": [
          {
            "slug": "marketing-automation"
          }
        ],
        "description": "HubSpot is your all-in-one stop for all of your marketing software needs."
      },
      "type": "authentication",
      "title": "Hubspot (example@zapier.com)",
      "is_expired": false
    }
  ],
  "description": "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 securely by Zapier.",
  "x-stoplight": {
    "id": "oglwzigsyobyg"
  }
}
object AuthenticationsCreateNewAuthenticationRequest 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "title",
        "app",
        "authentication_fields"
      ],
      "properties": {
        "app": {
          "type": "string",
          "format": "uuid",
          "example": "868f9d3c-2ea0-4f19-a32d-a61b276ab8de",
          "description": "A canonical App ID, as provided by the `/apps` endpoint.",
          "x-stoplight": {
            "id": "4t3xjr9hkys93"
          }
        },
        "title": {
          "type": "string",
          "example": "SuperExampleCRM (example@zapier.com)",
          "maxLength": 255,
          "description": "The title of the authentication.",
          "x-stoplight": {
            "id": "qsah1luqpw3aw"
          }
        },
        "authentication_fields": {
          "type": "object",
          "description": "Required values to create an authentication. These values will be used by the target integration to successfully create the Authentication https://platform.zapier.com/build/auth.",
          "x-stoplight": {
            "id": "qjdjpcuahd3ah"
          }
        }
      },
      "x-stoplight": {
        "id": "ikchkp3loucw7"
      }
    }
  }
}
object AuthenticationsCreateNewAuthenticationResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Authentication",
        "x-stoplight": {
          "id": "lxvorbxynz7q4"
        }
      },
      "x-stoplight": {
        "id": "sp4f7twbjuyvt"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta",
      "x-stoplight": {
        "id": "tnsnoe6rr38by"
      }
    },
    "links": {
      "$ref": "#/components/schemas/Links",
      "x-stoplight": {
        "id": "n7dl4exiymwf5"
      }
    }
  }
}
object AuthenticationsGetAvailableResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Authentication",
        "x-stoplight": {
          "id": "oglwzigsyobyg"
        }
      },
      "x-stoplight": {
        "id": "8xv9pjeka9p4w"
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    }
  }
}
object Choice 
{
  "type": "object",
  "title": "Choice",
  "example": {
    "id": "usaX",
    "type": "choice",
    "label": "United States of America",
    "value": "usa"
  },
  "required": [
    "type",
    "id",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "usa",
      "readOnly": true,
      "description": "The ID of this variant."
    },
    "type": {
      "type": "string",
      "const": "choice",
      "readOnly": true,
      "description": "The type of this object."
    },
    "label": {
      "type": "string",
      "example": "United States of America",
      "description": "An optional human-readable label for this variant. Useful if the actual value is not a human-readable value, such as an identifier.",
      "x-stoplight": {
        "id": "5o6snntc752sb"
      }
    },
    "value": {
      "type": "string",
      "example": "usa",
      "description": "The value of this variant.",
      "x-stoplight": {
        "id": "luo7utbtozgta"
      }
    }
  },
  "x-examples": [
    {
      "id": "usaX",
      "type": "choice",
      "label": "United States of America",
      "value": "usa"
    },
    {
      "id": "can",
      "type": "choice",
      "label": "Canada",
      "value": "can"
    },
    {
      "id": "mex",
      "type": "choice",
      "label": "Mexico",
      "value": "mex"
    }
  ],
  "x-internal": false,
  "description": "A single element from a set of Choices, variants in an enumeration. For example, selecting a country of residence in a dropdown of many available countries.",
  "x-stoplight": {
    "id": "lq9c04jbpe7a1"
  }
}
object ExperimentalGetZapRuns401Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error"
      }
    }
  }
}
object ExperimentalGetZapRuns403Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error"
      }
    }
  }
}
object ExperimentalGetZapRunsResponse 
{
  "type": "object",
  "properties": {
    "Meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ZapRun"
      },
      "description": "The list of Zap Runs."
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    }
  }
}
object Fieldset 
{
  "type": "object",
  "title": "Fieldset",
  "required": [
    "type",
    "id",
    "fields",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "invoice",
      "x-stoplight": {
        "id": "zcpcw8q2cwpua"
      }
    },
    "type": {
      "type": "string",
      "const": "fieldset",
      "readOnly": true,
      "description": "The type of this object."
    },
    "title": {
      "type": "string",
      "example": "Invoice",
      "description": "The human readable title for this group of fields.",
      "x-stoplight": {
        "id": "pi0vkrs14gvuw"
      }
    },
    "fields": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/Input-Field",
            "x-stoplight": {
              "id": "3zqy8q8a5wb1f"
            }
          },
          {
            "$ref": "#/components/schemas/Info-Field",
            "x-stoplight": {
              "id": "4wqirmr4nab68"
            }
          }
        ],
        "x-stoplight": {
          "id": "hxizjvnqn3z67"
        }
      },
      "minItems": 0,
      "x-stoplight": {
        "id": "xxeeq1r8znmkr"
      }
    }
  },
  "description": "A grouping of Input Fields and Info Fields. Usually displayed together under the provided heading.",
  "x-stoplight": {
    "id": "hhdrvc5sgwy4m"
  }
}
object Info-Field 
{
  "type": "object",
  "title": "Info Field",
  "required": [
    "type",
    "id",
    "description"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "response_msg",
      "x-stoplight": {
        "id": "hfp093gscz2lp"
      }
    },
    "type": {
      "type": "string",
      "const": "info_field",
      "readOnly": true,
      "description": "The type of this object."
    },
    "description": {
      "type": "string",
      "example": "Note that you can _only_ respond within 24 hours of a message sent by a user.",
      "description": "A markdown formatted piece of text that provides helpful information to the user.",
      "x-stoplight": {
        "id": "n4pc37fsx9n6j"
      }
    }
  },
  "description": "A field that is intended to display some useful information to the user. Often some longer form direction on how to configure further Input Fields, or restrictions imposed by the third party API.",
  "x-stoplight": {
    "id": "22g4l4bd4w92z"
  }
}
object Input-Field 
{
  "type": "object",
  "title": "Input Field",
  "example": {
    "id": "organisation",
    "type": "input_field",
    "title": "Organisation",
    "depends_on": [
      "workspace"
    ],
    "value_type": "STRING",
    "description": "Which organisation should new leads come from.",
    "is_required": true,
    "placeholder": "Type your Organisation name here!",
    "default_value": "My Organisation",
    "invalidates_input_fields": true
  },
  "required": [
    "type",
    "id",
    "default_value",
    "depends_on",
    "description",
    "invalidates_input_fields",
    "is_required",
    "placeholder",
    "title",
    "value_type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "organisation",
      "x-stoplight": {
        "id": "ptld3gl2q0z84"
      }
    },
    "type": {
      "enum": [
        "input_field",
        "info_field",
        "fieldset"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The type of this object."
    },
    "items": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "STRING",
            "NUMBER",
            "INTEGER",
            "BOOLEAN"
          ],
          "type": "string",
          "example": "STRING",
          "description": "Only set when `type` is `ARRAY`. Specifies the `type` of the elements of the array.",
          "x-stoplight": {
            "id": "36jutnzad1vni"
          }
        }
      },
      "x-stoplight": {
        "id": "x60ayzr6dil0w"
      }
    },
    "title": {
      "type": "string",
      "example": "Organisation",
      "description": "The title of this Input Field",
      "x-stoplight": {
        "id": "jwgnpz282do20"
      }
    },
    "format": {
      "enum": [
        "DATETIME",
        "MULTILINE",
        "PASSWORD",
        "CODE",
        "FILE",
        "SELECT"
      ],
      "type": "string",
      "example": "MULTILINE",
      "description": "An optional formatting hint, only provided when the `value_type` field is `STRING`. Useful for displaying more friendly inputs to a user. If the format is `SELECT`, you are expected to fetch the possible Choices from the `/choices` endpoint.",
      "x-stoplight": {
        "id": "26jrzyp6b8qte"
      }
    },
    "depends_on": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "workspace",
        "x-stoplight": {
          "id": "e8nq7zmnf1yp0"
        }
      },
      "description": "An array of ids that this field has a dependency on. If the value of these fields changes, the value of this field is no longer valid.",
      "x-stoplight": {
        "id": "g08w2x7p8m8j0"
      }
    },
    "value_type": {
      "enum": [
        "STRING",
        "NUMBER",
        "INTEGER",
        "BOOLEAN",
        "ARRAY",
        "OBJECT"
      ],
      "type": "string",
      "example": "STRING",
      "description": "The type of this Input Field. The `OBJECT` type accepts a flat key-value dictionary where the values can only be strings. The `ARRAY` type accepts an array of values - see `items` for the type. All other types accept string values.",
      "x-stoplight": {
        "id": "h9w5rc9ncwdqg"
      }
    },
    "description": {
      "type": "string",
      "example": "Which organisation should new leads come from.",
      "description": "A longer markdown formatted description of this Input Field, often containing helpful hints on how to fill this particular field in.",
      "x-stoplight": {
        "id": "hrthwkkkz1ee9"
      }
    },
    "is_required": {
      "type": "boolean",
      "description": "If true, this field must be filled in for the action to execute.",
      "x-stoplight": {
        "id": "cf6yq2dcpjoik"
      }
    },
    "placeholder": {
      "type": "string",
      "example": "Type your Organisation name here!",
      "description": "A placeholder for this Input Field."
    },
    "default_value": {
      "type": "string",
      "example": "My Organisation",
      "description": "The default value of this Input Field"
    },
    "invalidates_input_fields": {
      "type": "boolean",
      "description": "If true, changes to this field invalidate the presence of all other fields for this action and they must be refetched.",
      "x-stoplight": {
        "id": "6dmhtkigi6928"
      }
    }
  },
  "x-examples": [
    {
      "id": "organisation",
      "type": "input_field",
      "title": "Organisation",
      "depends_on": [
        "workspace"
      ],
      "value_type": "STRING",
      "description": "Which organisation should new leads come from.",
      "is_required": true,
      "placeholder": "Type your Organisation name here!",
      "default_value": "My Organisation",
      "invalidates_input_fields": true
    }
  ],
  "x-internal": false,
  "description": "A field that is an input to an Action, often eventually used to form the HTTP request that is made to a Partner API.",
  "x-stoplight": {
    "id": "aa89vbos7u7bt"
  }
}
object InputsWithAuthenticationId 
{
  "type": "object",
  "examples": {
    "limit": 10,
    "inputs": {
      "stage_name": "CLOSED_WON"
    },
    "offset": 20,
    "authentication": "BRn9rRg"
  },
  "required": [
    "authentication",
    "inputs"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "format": "int32",
      "description": "Used for paginating results. Specifies the maximum number of items to return per page."
    },
    "inputs": {
      "type": "object",
      "description": "The current set of input fields in a JSON object, where each key is the `id` of an Input Field, and the corresponding value the current value of the field."
    },
    "offset": {
      "type": "integer",
      "format": "int32",
      "description": "Used for paginating results. Specifies the offset to use."
    },
    "authentication": {
      "type": [
        "string",
        "null"
      ],
      "description": "An Authentication ID, as provided by the `/authentications` endpoint.",
      "x-stoplight": {
        "id": "x4243l2r0sn61"
      }
    }
  },
  "description": "The common data object that includes inputs and an authentication id."
}
object InputsWithAuthenticationIdAndFetchLiveSamples 
{
  "type": "object",
  "title": "InputsWithAuthenticationIdAndFetchLiveSamples",
  "examples": {
    "limit": 10,
    "inputs": {
      "stage_name": "CLOSED_WON"
    },
    "offset": 20,
    "authentication": "BRn9rRg"
  },
  "required": [
    "authentication",
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "object",
      "description": "The current set of input fields in a JSON object, where each key is the `id` of an Input Field, and the corresponding value the current value of the field."
    },
    "authentication": {
      "type": [
        "string",
        "null"
      ],
      "description": "An Authentication ID, as provided by the `/authentications` endpoint."
    },
    "fetch_live_samples": {
      "type": "boolean",
      "default": false,
      "description": "Whether to retrieve live samples for the field",
      "x-stoplight": {
        "id": "sztwd2jml2g66"
      }
    }
  },
  "description": "The common data object that includes inputs and an authentication id.",
  "x-stoplight": {
    "id": "slf9f11zlbpep"
  }
}
object InputsWithAuthenticationIdNoPage 
{
  "type": "object",
  "title": "InputsWithAuthenticationIdNoPage",
  "example": {
    "inputs": {
      "text": "Hi there",
      "channel": "U036WM3E84D"
    },
    "authentication": "BRn9rRg"
  },
  "properties": {
    "inputs": {
      "type": "object",
      "description": "The current set of input fields in a JSON object, where each key is the `id` of an Input Field, and the corresponding value the current value of the field.",
      "x-stoplight": {
        "id": "b03fuc0a4gv7j"
      }
    },
    "authentication": {
      "type": [
        "string",
        "null"
      ],
      "example": "BRn9rRg",
      "description": "An Authentication ID, as provided by the `/authentications` endpoint.",
      "x-stoplight": {
        "id": "xnxoa9djz4t00"
      }
    }
  },
  "x-examples": [
    {
      "inputs": {
        "text": "Hi there",
        "channel": "U036WM3E84D"
      },
      "authentication": "BRn9rRg"
    },
    {
      "inputs": {
        "worksheet": "0",
        "spreadsheet": "1eM41g5BqFpGi1O2BTlc7cA_MNj2mujLJ_QNRwuWQ-rc"
      },
      "authentication": "BRn9rRg"
    }
  ],
  "x-stoplight": {
    "id": "hngkbpz9wble3"
  }
}
object JSON-Error 
{
  "type": "object",
  "title": "JSON Error",
  "example": {
    "code": "unauthenticated",
    "meta": {
      "source": "ZAPIER"
    },
    "title": "User Not Authenticated",
    "detail": "User must be authenticated to access this resource",
    "status": "401"
  },
  "properties": {
    "code": {
      "type": "string",
      "example": "unauthenticated"
    },
    "meta": {
      "type": "object",
      "properties": {
        "source": {
          "enum": [
            "ZAPIER",
            "THIRD_PARTY"
          ],
          "type": "string",
          "readOnly": true,
          "x-stoplight": {
            "id": "1xvz8q83ku44e"
          }
        }
      },
      "x-stoplight": {
        "id": "7dafj9ijy9rbh"
      }
    },
    "title": {
      "type": "string",
      "example": "User Not Authenticated"
    },
    "detail": {
      "type": "string",
      "example": "User must be authenticated to access this resource"
    },
    "status": {
      "type": "string",
      "example": "401",
      "pattern": "^\\d{3}"
    }
  },
  "x-examples": [
    {
      "code": "unauthenticated",
      "meta": {
        "source": "ZAPIER"
      },
      "title": "User Not Authenticated",
      "detail": "User must be authenticated to access this resource",
      "status": "401"
    }
  ]
}
object Links 
{
  "type": "object",
  "title": "Links",
  "properties": {
    "next": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "default": null,
      "example": "https://api.zapier.com/v2/apps?offset=20&limit=10",
      "pattern": "^https:\\/\\/api\\.zapier\\.com\\/.*",
      "nullable": true,
      "readOnly": true,
      "description": "The URL of the next page of paginated results.",
      "x-stoplight": {
        "id": "w5nhbvv8b1r4r"
      }
    },
    "prev": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "default": null,
      "example": "https://api.zapier.com/v2/apps?offset=0&limit=10",
      "pattern": "^https:\\/\\/api\\.zapier\\.com\\/.*",
      "nullable": true,
      "readOnly": true,
      "description": "The URL of the previous page of paginated results.",
      "x-stoplight": {
        "id": "3rs1teh1vdfoz"
      }
    }
  },
  "description": "The links object returned in paginated response bodies.",
  "x-stoplight": {
    "id": "g3mw8odxd2a5b"
  }
}
object LinksWithPage 
{
  "type": "object",
  "title": "LinksWithPage",
  "properties": {
    "next": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "default": null,
      "example": "https://api.zapier.com/v2/actions/core:abcd/inputs/lead_id/choices?page=3",
      "pattern": "^https:\\/\\/api\\.zapier\\.com\\/.*",
      "nullable": true,
      "readOnly": true,
      "description": "The URL of the next page of paginated results.",
      "x-stoplight": {
        "id": "1qw4ipgciehf5"
      }
    },
    "prev": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "default": null,
      "example": "https://api.zapier.com/v2/actions/core:abcd/inputs/lead_id/choices?page=1",
      "pattern": "^https:\\/\\/api\\.zapier\\.com\\/.*",
      "nullable": true,
      "readOnly": true,
      "description": "The URL of the previous page of paginated results.",
      "x-stoplight": {
        "id": "00b22pohany81"
      }
    }
  },
  "description": "The links object returned in paginated response bodies.",
  "x-stoplight": {
    "id": "xzqnni6w46yxz"
  }
}
object Meta 
{
  "type": "object",
  "title": "Meta",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int32",
      "example": 133,
      "minimum": 0,
      "readOnly": true,
      "description": "The total number of objects in the collection represented by the endpoint.",
      "x-stoplight": {
        "id": "nh8w20vy7kwk4"
      }
    },
    "limit": {
      "type": "integer",
      "format": "int32",
      "example": 10,
      "minimum": 1,
      "readOnly": true,
      "description": "The limit value used in the request.",
      "x-stoplight": {
        "id": "2fm9jmi21w2gp"
      }
    },
    "offset": {
      "type": "integer",
      "format": "int32",
      "default": 0,
      "example": 10,
      "minimum": 0,
      "description": "The offset value used in the request.",
      "x-stoplight": {
        "id": "eio99why05ylu"
      }
    }
  },
  "description": "The meta object returned in paginated response bodies.",
  "x-stoplight": {
    "id": "msk45ygr2wrc8"
  }
}
object MetaWithPage 
{
  "type": "object",
  "title": "MetaWithPage",
  "properties": {
    "page": {
      "type": "integer",
      "format": "int32",
      "default": 1,
      "example": 10,
      "readOnly": true,
      "description": "The page of results requested",
      "x-stoplight": {
        "id": "u85us29cgmyin"
      }
    }
  },
  "description": "The meta object returned in paginated response bodies, for results using cursor pagination.",
  "x-stoplight": {
    "id": "ltgg98ltcua97"
  }
}
object Output-Field 
{
  "type": "object",
  "title": "Output Field",
  "examples": [],
  "required": [
    "type",
    "id",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "first_name",
      "x-stoplight": {
        "id": "k1d6ihtkkr55w"
      }
    },
    "type": {
      "type": "string",
      "const": "output_field",
      "readOnly": true,
      "description": "The type of this object."
    },
    "title": {
      "type": "string",
      "example": "First Name",
      "description": "The title of this Output Field"
    },
    "sample": {
      "type": "string",
      "example": "Wade",
      "description": "An optional sample of the data this Output Field might contain.",
      "x-stoplight": {
        "id": "uksm0x6z9rtf8"
      }
    }
  },
  "x-internal": false,
  "description": "A field that is an output from an Action, often fields returned from a call to a Partner API.",
  "x-stoplight": {
    "id": "s11ejctoftpqj"
  }
}
object Zap 
{
  "type": "object",
  "title": "Zap",
  "example": {
    "id": "00000000-0000-c000-8000-000000012345X",
    "type": "zap",
    "links": {
      "html_editor": "https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345"
    },
    "steps": [
      {
        "title": null,
        "action": "uag:1f188536-6dd0-4172-8414-2b90914ddee9",
        "inputs": {},
        "authentication": "b3eYnwl"
      },
      {
        "title": null,
        "action": "uag:1f188536-6dd0-4172-8414-2b90914ddaa7",
        "inputs": {},
        "authentication": "BRn9rRg"
      }
    ],
    "title": "My Zap",
    "is_enabled": true,
    "updated_at": "2019-08-24T14:15:22Z",
    "last_successful_run_date": "2019-08-24T14:15:22Z"
  },
  "required": [
    "steps",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "00000000-0000-c000-8000-000000012345",
      "readOnly": true,
      "description": "A unique identifier of the Zap.",
      "x-stoplight": {
        "id": "l4qxuok0cmebd"
      }
    },
    "type": {
      "type": "string",
      "const": "zap",
      "readOnly": true,
      "description": "The type of this object."
    },
    "links": {
      "type": "object",
      "properties": {
        "html_editor": {
          "type": "string",
          "format": "uri",
          "example": "https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345",
          "readOnly": true,
          "description": "A link to open this Zap in the Zapier editor.",
          "x-stoplight": {
            "id": "6xn8sd4td5xox"
          }
        }
      },
      "x-stoplight": {
        "id": "uhxxzqjelbfwj"
      }
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "action",
          "inputs",
          "authentication"
        ],
        "properties": {
          "title": {
            "type": [
              "string",
              "null"
            ],
            "readOnly": true,
            "description": "The custom title of a Zap Step. If a step has not been given a custom title by the user, then the value will be null.",
            "x-stoplight": {
              "id": "vk6hcwjt56em9"
            }
          },
          "action": {
            "oneOf": [
              {
                "type": "string",
                "example": "uag:1f188536-6dd0-4172-8414-2b90914ddee9",
                "pattern": "^[\\w-]+:[\\w-]+$",
                "description": "The ID of the Action associated with this Zap step.",
                "x-stoplight": {
                  "id": "9hy7nxswu8fjx"
                }
              },
              {
                "$ref": "#/components/schemas/Action",
                "description": "The full Action object associated with this Zap step.",
                "x-stoplight": {
                  "id": "hma580f0ue7v8"
                }
              }
            ],
            "description": "Expandable. The Action associated with this Zap step.",
            "x-stoplight": {
              "id": "17r78o3clw7i9"
            }
          },
          "inputs": {
            "type": "object",
            "x-stoplight": {
              "id": "v7n5ic7azuqwv"
            }
          },
          "authentication": {
            "oneOf": [
              {
                "type": [
                  "string",
                  "null"
                ],
                "example": "b3eYnwl",
                "description": "The ID of the Authentication associated with this Zap step (or null if the step requires no authentication)."
              },
              {
                "$ref": "#/components/schemas/Authentication",
                "description": "The full Authentication object associated with this Zap step.",
                "x-stoplight": {
                  "id": "heks0kiakn29j"
                }
              }
            ],
            "description": "Expandable. The Authentication associated with this zap step.",
            "x-stoplight": {
              "id": "kpwkdn1f8ynyf"
            }
          }
        },
        "x-stoplight": {
          "id": "7e9kkmuykf25n"
        }
      },
      "minItems": 2,
      "description": "An ordered list of steps that define the logic of the Zap.",
      "uniqueItems": true,
      "x-stoplight": {
        "id": "6qmwdphlufjiy"
      }
    },
    "title": {
      "type": "string",
      "example": "My Zap",
      "description": "The human readable name of the Zap.",
      "x-stoplight": {
        "id": "mpl1ssngg9udx"
      }
    },
    "is_enabled": {
      "type": "boolean",
      "default": true,
      "description": "Whether the Zap is enabled (running) or not.",
      "x-stoplight": {
        "id": "fttr3poioh3a2"
      }
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$",
      "readOnly": true,
      "x-stoplight": {
        "id": "wowgqxucfqqgz"
      }
    },
    "last_successful_run_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "readOnly": true,
      "description": "The date/time at which this Zap last ran sucessfully. A null value indicates that a Zap has never run successfully.",
      "x-stoplight": {
        "id": "a9wvhqpq7jtna"
      }
    }
  },
  "x-examples": [
    {
      "id": "00000000-0000-c000-8000-000000012345X",
      "type": "zap",
      "links": {
        "html_editor": "https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345"
      },
      "steps": [
        {
          "title": null,
          "action": "uag:1f188536-6dd0-4172-8414-2b90914ddee9",
          "inputs": {},
          "authentication": "b3eYnwl"
        },
        {
          "title": null,
          "action": "uag:1f188536-6dd0-4172-8414-2b90914ddaa7",
          "inputs": {},
          "authentication": "BRn9rRg"
        }
      ],
      "title": "My Zap",
      "is_enabled": true,
      "updated_at": "2019-08-24T14:15:22Z",
      "last_successful_run_date": "2019-08-24T14:15:22Z"
    },
    {
      "id": "00000000-0000-c000-8000-000000012345",
      "type": "zap",
      "links": {
        "html_editor": "https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345"
      },
      "steps": [
        {
          "title": null,
          "action": {
            "id": "uag:1f188536-6dd0-4172-8414-2b90914ddee9",
            "app": {
              "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaa",
              "type": "app",
              "image": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
              "links": {
                "connect_new_authentication": "https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
              },
              "title": "HubSpot",
              "images": {
                "url_16x16": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
                "url_32x32": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
                "url_64x64": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
                "url_128x128": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
              },
              "hex_color": "8bcbca",
              "categories": [
                {
                  "slug": "marketing-automation"
                }
              ],
              "description": "HubSpot is your all-in-one stop for all of your marketing software needs."
            },
            "type": "action",
            "title": "New Deal",
            "action_type": "READ",
            "description": "Triggers when a new deal is created."
          },
          "inputs": {},
          "authentication": {
            "id": "b3eYnwl",
            "app": {
              "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaa",
              "type": "app",
              "image": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
              "links": {
                "connect_new_authentication": "https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
              },
              "title": "HubSpot",
              "images": {
                "url_16x16": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
                "url_32x32": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
                "url_64x64": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
                "url_128x128": "https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
              },
              "hex_color": "8bcbca",
              "categories": [
                {
                  "slug": "marketing-automation"
                }
              ],
              "description": "HubSpot is your all-in-one stop for all of your marketing software needs."
            },
            "type": "authentication",
            "title": "Hubspot (example@zapier.com)"
          }
        },
        {
          "title": null,
          "action": {
            "id": "uag:1f188536-6dd0-4172-8414-2b90914ddaa7",
            "app": {
              "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecaacc",
              "url": "https://api.zapier.com/v1/embed/apps/facebook-lead-ads-beta/integrations/facebook-lead-ads-beta",
              "type": "app",
              "image": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
              "links": {
                "connect_new_authentication": "https://zapier.com/engine/auth/start/FacebookLeadAdsCLIAPI@1.6.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
              },
              "title": "Facebook Lead Ads",
              "images": {
                "url_16x16": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
                "url_32x32": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
                "url_64x64": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
                "url_128x128": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
              },
              "hex_color": "1878f3",
              "categories": [
                {
                  "slug": "ads-conversion"
                }
              ],
              "description": "Facebook lead ads make signing up for business information easy for people and more valuable for businesses. The Facebook lead ad app is useful for marketers who want to automate actions on their leads."
            },
            "type": "action",
            "title": "Create Ad Statistics Report",
            "action_type": "WRITE",
            "description": "Creates a report of Ad Statistics"
          },
          "inputs": {},
          "authentication": {
            "id": "BRn9rRg",
            "app": {
              "id": "1e4fcbf4-d80b-4ec3-b33b-c085f1ecaacc",
              "url": "https://api.zapier.com/v1/embed/apps/facebook-lead-ads-beta/integrations/facebook-lead-ads-beta",
              "type": "app",
              "image": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50",
              "links": {
                "connect_new_authentication": "https://zapier.com/engine/auth/start/FacebookLeadAdsCLIAPI@1.6.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect"
              },
              "title": "Facebook Lead Ads",
              "images": {
                "url_16x16": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16",
                "url_32x32": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32",
                "url_64x64": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64",
                "url_128x128": "https://zapier-images.imgix.net/storage/services/f407c31b217aac6e0cd4171092d53a8c_3.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128"
              },
              "hex_color": "1878f3",
              "categories": [
                {
                  "slug": "ads-conversion"
                }
              ],
              "description": "Facebook lead ads make signing up for business information easy for people and more valuable for businesses. The Facebook lead ad app is useful for marketers who want to automate actions on their leads."
            },
            "type": "authentication",
            "title": "Facebook Lead Ads (example@zapier.com)"
          }
        }
      ],
      "title": "My Zap",
      "is_enabled": true,
      "updated_at": "2019-08-24T14:15:22Z",
      "last_successful_run_date": "2019-08-24T14:15:22Z"
    }
  ],
  "description": "The definition of the Zap that will be created.",
  "x-stoplight": {
    "id": "vw89ibjhro143"
  }
}
object ZapRun 
{
  "type": "object",
  "title": "ZapRun",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "00946041-b63b-a34c-9c30-630c32f0c3a4",
      "description": "Zap Run Identifier."
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ZapRunStep"
      },
      "description": "The list of sequential actions or processes involved in the execution of the associated Zap run."
    },
    "status": {
      "enum": [
        "delayed",
        "scheduled",
        "pending",
        "error",
        "halted",
        "throttled",
        "held",
        "filtered",
        "skipped",
        "success"
      ],
      "type": "string",
      "readOnly": true,
      "description": "Represents the current state or progress of the Zap Run"
    },
    "data_in": {
      "type": "string",
      "description": "The information about the data inputted into and logged out from a specific Zap Run during its execution."
    },
    "data_out": {
      "type": "string",
      "description": "The information logged out from a specific Zap Run during its execution."
    },
    "end_time": {
      "type": "string",
      "format": "date-time",
      "example": "2023-12-01T06:29:10.360000+00:00",
      "readOnly": true,
      "description": "The specific time when the Zap Run was finished."
    },
    "zap_title": {
      "type": "string",
      "example": "Zap Title - New Item",
      "readOnly": true,
      "description": "Refers to the name or title of the specific Zap that the run is associated with."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2023-12-01T06:29:10.360000+00:00",
      "readOnly": true,
      "description": "The specific time when the Zap Run was initiated."
    }
  }
}
object ZapRunStep 
{
  "type": "object",
  "title": "ZapRunStep",
  "properties": {
    "status": {
      "enum": [
        "delayed",
        "scheduled",
        "pending",
        "error",
        "halted",
        "throttled",
        "held",
        "filtered",
        "skipped",
        "success"
      ],
      "type": "string",
      "readOnly": true,
      "description": "Represents the current state or progress of the Zap Run Step."
    },
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2023-12-01T06:29:15.870509+00:00",
      "readOnly": true,
      "description": "The specific time when the execution of the step in the Zap run began."
    }
  }
}
object ZapsCreateZapRequest 
{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Zap",
      "description": "The definition of the Zap that will be created.",
      "x-stoplight": {
        "id": "vw89ibjhro143"
      }
    }
  }
}
object ZapsCreateZapResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Zap",
      "x-stoplight": {
        "id": "oqmlg56a9ej8h"
      }
    }
  }
}
object ZapsGetFilteredZaps401Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error",
        "x-stoplight": {
          "id": "l58vecxneaykz"
        }
      },
      "x-stoplight": {
        "id": "vdmg3yluafenr"
      }
    }
  }
}
object ZapsGetFilteredZaps403Response 
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JSON-Error"
      }
    }
  }
}
object ZapsGetFilteredZapsResponse 
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Zap",
        "x-stoplight": {
          "id": "sxhd9c6l6g7ua"
        }
      }
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    }
  }
}