openapi: 3.1.0
info:
  title: Partner API
  version: 2024.11.0
  description: |2

    ## Introduction

    The Partner API is the best tool for complete style control over a user's Zapier experience within your app.
    Essentially, it lets you customize how you present Zapier within your product without sacrificing your app's look,
    feel, and flow.

    Think of it as a native Zapier integration, helping you showcase your best Zapier-powered workflows where it's most
    helpful to your users (within the flow of your tool). You can customize styling, streamline Zap set-up for users,
    expose relevant Zap information, and more!

    With the Partner API, you can:

    - Get a list of all the apps available in Zapier's app directory so you can power your app directory and show your
    users all the integration possibilities with your Zapier integration.
    - Have complete style control over how you present Zap templates in your product. The Partner API gives you access
    to the raw Zap Template data so you can give your users access to your Zap template with your product's style, look
    and feel.
    - Get access to all your Zap templates and give your users the ability to search to quickly find the one they need.
    - Streamline Zap setup by pre-filling fields on behalf of your users.
    - Show users the Zaps they have set up from right within your product keeping them on your site longer and giving them
    complete confidence in their Zapier integration.
    - Embed our Zapier Editor to allow your users to create new Zaps and modify existing ones, without needing to leave
    your product.

    ## Authentication

    There are two ways to authenticate with the Partner API.

    1. Your application's `client_id` which you will receive once you are approved for access to the API
    (Client ID Authentication)
    2. A user's access token (Access Token Authentication).

    Which authentication method you should use depends on which endpoint(s) you are using.
    Review each endpoint's documentation to understand which parameters are required.

    > Note: while we do generate a `client_secret`, the type of grant we use (implicit) doesn't
    need it so it's not something we provide.'

    ## Learn more

    See the [Workflow API documentation](https://docs.zapier.com/partner-solutions/workflow-api/intro) for more information.
  contact:
    name: Zapier
    url: https://developer.zapier.com/contact
paths:
  /v1/apps:
    get:
      operationId: v1_apps_list
      description: This endpoint returns a list of apps sorted popularity. See the List Apps guide to get started.
      summary: Zapier Get Apps [v1]
      parameters:
        - in: query
          name: category
          schema:
            type: string
          description: Categories that apps must have in order to be returned in the response
          example: google
        - in: query
          name: is_in_zap_template_with
          schema: {}
          description: If set, only return apps that are in a Zap Template with your app
          example: ''
        - in: query
          name: page
          schema:
            type: number
          description: Which page to return
          example: 42.5
        - in: query
          name: per_page
          schema:
            type: number
          description: Number of results to return per page
          example: 42.5
        - in: query
          name: title_search
          schema:
            type: string
          description: Case-insensitive parameter to limit the results to apps whose titles match
          example: google+calendar
        - in: query
          name: title_starts_with
          schema:
            type: string
          description: Case-insensitive parameter to only return apps whose titles start with the parameter value in the response
          example: google
      tags:
        - Apps
      security:
        - ClientIDAuthentication: []
      responses:
        '403':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_apps_list403Example:
                  summary: Default v1_apps_list 403 response
                  x-microcks-default: true
                  value: {}
          description: 403 Response
        '401':
          description: Missing client_id in query parameters
        '409':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_apps_list409Example:
                  summary: Default v1_apps_list 409 response
                  x-microcks-default: true
                  value: {}
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_apps_list429Example:
                  summary: Default v1_apps_list 429 response
                  x-microcks-default: true
                  value: {}
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_apps_list503Example:
                  summary: Default v1_apps_list 503 response
                  x-microcks-default: true
                  value: {}
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_apps_list504Example:
                  summary: Default v1_apps_list 504 response
                  x-microcks-default: true
                  value: {}
          description: 504 Response
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppsResponse'
              examples:
                /v1/apps:
                  value:
                    - total: 3649
                      page: 2
                      pages: 1825
                      per_page: 2
                      objects:
                        - uuid: ca83afc5-ee9a-470d-b577-e7f8fd555b67
                          title: Slack
                          slug: slack
                          description: 'Slack is a platform for team communication: everything in one place, instantly searchable, available wherever you go. Offering instant messaging, document sharing
                            and knowledge search for modern teams.'
                          image: https://zapier-images.imgix.net/storage/services/6cf3f5a461feadfba7abc93c4c395b33_2.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50
                          url: https://api.zapier.com/v1/embed/apps/google-ads/integrations/slack
                          links:
                            mutual:zap_templates: https://api.zapier.com/v1/zap-templates?apps=slack&utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                          categories:
                            - slug: team-chat
                          images:
                            url_16x16: https://zapier-images.imgix.net/storage/services/6cf3f5a461feadfba7abc93c4c395b33_2.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/6cf3f5a461feadfba7abc93c4c395b33_2.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/6cf3f5a461feadfba7abc93c4c395b33_2.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/6cf3f5a461feadfba7abc93c4c395b33_2.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128
                          app_latest: SlackCLIAPI@latest
                        - uuid: d74234df-0045-436e-bd5b-ee577e74e6b8
                          title: Google Calendar
                          slug: google-calendar
                          description: Google Calendar lets you organize your schedule and share events with co-workers and friends. With Google's free online calendar, it's easy to keep track of your
                            daily schedule.
                          image: https://zapier-images.imgix.net/storage/services/62c82a7958c6c29736f17d0495b6635c.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50
                          url: https://api.zapier.com/v1/embed/apps/google-ads/integrations/google-calendar
                          links:
                            mutual:zap_templates: https://api.zapier.com/v1/zap-templates?apps=google-calendar&utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                          categories:
                            - slug: calendar
                            - slug: google
                          images:
                            url_16x16: https://zapier-images.imgix.net/storage/services/62c82a7958c6c29736f17d0495b6635c.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/62c82a7958c6c29736f17d0495b6635c.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/62c82a7958c6c29736f17d0495b6635c.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/62c82a7958c6c29736f17d0495b6635c.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128
                          app_latest: GoogleCalendarCLIAPI@latest
                      prev_url: https://api.zapier.com/v1/apps?per_page=2&page=1
                      next_url: https://api.zapier.com/v1/apps?per_page=2&page=3
                  description: |2

                    - Your own app will not be returned.
                    - Zapier built-in apps will not be returned.
                    - Order of the result is by app popularity.
          description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/categories:
    get:
      operationId: v1_categories_list
      description: List of Zap categories
      summary: Zapier Get Categories
      parameters:
        - in: query
          name: limit
          schema:
            type: number
            default: 10
          description: Limit the number of Zap categories returned.
          example: 10
        - in: query
          name: offset
          schema:
            type: number
            default: 0
          description: The number of Zap categories to skip over. The default value is 0, which is the offset of the first item.
          example: 0
      tags:
        - Categories
      responses:
        '403':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_categories_list403Example:
                  summary: Default v1_categories_list 403 response
                  x-microcks-default: true
                  value: {}
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_categories_list401Example:
                  summary: Default v1_categories_list 401 response
                  x-microcks-default: true
                  value: {}
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_categories_list409Example:
                  summary: Default v1_categories_list 409 response
                  x-microcks-default: true
                  value: {}
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_categories_list429Example:
                  summary: Default v1_categories_list 429 response
                  x-microcks-default: true
                  value: {}
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_categories_list503Example:
                  summary: Default v1_categories_list 503 response
                  x-microcks-default: true
                  value: {}
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_categories_list504Example:
                  summary: Default v1_categories_list 504 response
                  x-microcks-default: true
                  value: {}
          description: 504 Response
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CategoriesResponse'
              examples:
                /v1/categories:
                  value:
                    - next: https://api.zapier.com/v1/categories?offset=10&limit=10
                      previous:
                      count: 90
                      objects:
                        - id: 78
                          title: Ads & Conversion
                          slug: ads-conversion
                          description: Tools to track and reach an audience online.
                          url: https://zapier.com/api/v4/app-directory/categories/ads-conversion/
                          type_of: curated
                          featured_entry_slug: boost-google-ads-ROI-with-zapier
                          role: child
                        - id: 1
                          title: Accounting
                          slug: accounting
                          description: Tools for accounting and finance.
                          url: https://zapier.com/api/v4/app-directory/categories/accounting/
                          type_of: curated
                          featured_entry_slug: favorite-zaps-accounting
                          role: child
                        - id: 14
                          title: AI Tools
                          slug: ai-tools
                          description: Unlock the potential of artificial intelligence in your workflow with these AI integrations. These apps use AI to tackle everything from natural language 
                            processing to image classification, providing you with unparalleled automation power.
                          url: https://zapier.com/api/v4/app-directory/categories/ai-tools/
                          type_of: curated
                          featured_entry_slug:
                          role: parent
                        - id: 97
                          title: All
                          slug: all
                          description: Contains all the services.
                          url: https://zapier.com/api/v4/app-directory/categories/all/
                          type_of: auto
                          featured_entry_slug:
                          role: parent
                        - id: 37
                          title: Amazon
                          slug: aws
                          description: Tools from Amazon to host and manage sites and applications on the Amazon cloud.
                          url: https://zapier.com/api/v4/app-directory/categories/aws/
                          type_of: curated
                          featured_entry_slug: what-you-should-automate
                          role: child
                        - id: 84
                          title: Analytics
                          slug: analytics
                          description: Tools to measure and report on success
                          url: https://zapier.com/api/v4/app-directory/categories/analytics/
                          type_of: curated
                          featured_entry_slug: automate-analytics-tools
                          role: child
                        - id: 21
                          title: App Builder
                          slug: app-builder
                          description: Tools to build a custom app with forms and databases.
                          url: https://zapier.com/api/v4/app-directory/categories/app-builder/
                          type_of: curated
                          featured_entry_slug:
                          role: child
                        - id: 35
                          title: App Families
                          slug: app-families
                          description: ''
                          url: https://zapier.com/api/v4/app-directory/categories/app-families/
                          type_of: curated
                          featured_entry_slug:
                          role: parent
                        - id: 155
                          title: Artificial Intelligence
                          slug: artificial-intelligence
                          description: Unlock the potential of artificial intelligence in your workflow with these AI integrations. These apps use AI to tackle everything from natural language 
                            processing to image classification, providing you with unparalleled automation power.
                          url: https://zapier.com/api/v4/app-directory/categories/artificial-intelligence/
                          type_of: curated
                          featured_entry_slug:
                          role: parent
                        - id: 46
                          title: Beta
                          slug: beta
                          description: Beta services.
                          url: https://zapier.com/api/v4/app-directory/categories/beta/
                          type_of: auto
                          featured_entry_slug:
                          role: child
          description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/profiles/me:
    get:
      operationId: v1_profiles_me_list
      description: |-
        This endpoint returns the authenticated user information

        #### When using OAuth

        This endpoint requires the `profile` OAuth scope.
      summary: Zapier User Profile
      tags:
        - Accounts
      security:
        - OAuth:
            - profile
      responses:
        '403':
          description: Invalid authentication
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_profiles_me_list401Example:
                  summary: Default v1_profiles_me_list 401 response
                  x-microcks-default: true
                  value: {}
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_profiles_me_list409Example:
                  summary: Default v1_profiles_me_list 409 response
                  x-microcks-default: true
                  value: {}
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_profiles_me_list429Example:
                  summary: Default v1_profiles_me_list 429 response
                  x-microcks-default: true
                  value: {}
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_profiles_me_list503Example:
                  summary: Default v1_profiles_me_list 503 response
                  x-microcks-default: true
                  value: {}
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_profiles_me_list504Example:
                  summary: Default v1_profiles_me_list 504 response
                  x-microcks-default: true
                  value: {}
          description: 504 Response
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Profile'
              examples:
                Profile:
                  value:
                    - id: 88998899
                      first_name: Jacob
                      last_name: Corwin
                      full_name: Jacob Corwin
                      email: jacob.corwin@zapier.example
                      email_confirmed: true
                      timezone: America/Toronto
                  summary: profile
          description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/zap-templates:
    get:
      operationId: v1_zap_templates_list
      description: List popular Zap Templates using your app. See our List Zap Templates guide to get started.
      summary: Zapier Get Zap Templates
      parameters:
        - in: query
          name: apps
          schema:
            type: string
          description: |-
            A comma separated list of Zapier Apps to match Zap templates against. Note:
            - Your app will always be one of the apps in the template
            - The list will return Zap Templates with all the provided apps, not a subset
          example: mailchimp
        - in: query
          name: limit
          schema:
            type: number
            default: 5
          description: '(Max: 100) Limit the number of Zap templates returned.'
          example: 5
        - in: query
          name: offset
          schema:
            type: number
            default: 0
          description: The number of Zap templates to skip before beginning to return the Zap templates. The default value is 0, which is the offset of the first item.
          example: 0
      tags:
        - Zap Templates
      security:
        - ClientIDAuthentication: []
      responses:
        '403':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zap_templates_list403Example:
                  summary: Default v1_zap_templates_list 403 response
                  x-microcks-default: true
                  value: {}
          description: 403 Response
        '401':
          description: Missing client_id in query parameters
        '409':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zap_templates_list409Example:
                  summary: Default v1_zap_templates_list 409 response
                  x-microcks-default: true
                  value: {}
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zap_templates_list429Example:
                  summary: Default v1_zap_templates_list 429 response
                  x-microcks-default: true
                  value: {}
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zap_templates_list503Example:
                  summary: Default v1_zap_templates_list 503 response
                  x-microcks-default: true
                  value: {}
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zap_templates_list504Example:
                  summary: Default v1_zap_templates_list 504 response
                  x-microcks-default: true
                  value: {}
          description: 504 Response
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ZapTemplate'
              examples:
                /v1/zap-templates:
                  value:
                    - id: 51652
                      steps:
                        - id: 1
                          uuid: b9df4eff-f311-44f9-ac54-2901f952c6ac
                          title: Google Ads
                          slug: google-ads
                          description: Google Ads (formerly Google AdWords) is an online advertising platform developed by Google, where advertisers pay to display brief advertisements, service 
                            offerings, product listings, video content, and generate mobile application installs within the Google ad network to web users.
                          image: https://zapier-images.imgix.net/storage/services/4058ec8b47ad751cbd39bd686cf4eab7.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50
                          hex_color: 4285F4
                          images:
                            url_16x16: https://zapier-images.imgix.net/storage/services/4058ec8b47ad751cbd39bd686cf4eab7.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/4058ec8b47ad751cbd39bd686cf4eab7.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/4058ec8b47ad751cbd39bd686cf4eab7.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/4058ec8b47ad751cbd39bd686cf4eab7.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128
                          api: GoogleAdsCLIAPI@3.0.0
                          url: https://zapier.com/apps/google-ads/integrations?utm_medium=partner_api
                          label: New Campaign
                        - id: 2
                          uuid: ca83afc5-ee9a-470d-b577-e7f8fd555b67
                          title: Slack
                          slug: slack
                          description: 'Slack is a platform for team communication: everything in one place, instantly searchable, available wherever you go. Offering instant messaging, document sharing
                            and knowledge search for modern teams.'
                          image: https://zapier-images.imgix.net/storage/services/6cf3f5a461feadfba7abc93c4c395b33_2.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50
                          hex_color: 510f4d
                          images:
                            url_16x16: https://zapier-images.imgix.net/storage/services/6cf3f5a461feadfba7abc93c4c395b33_2.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/6cf3f5a461feadfba7abc93c4c395b33_2.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/6cf3f5a461feadfba7abc93c4c395b33_2.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/6cf3f5a461feadfba7abc93c4c395b33_2.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128
                          api: SlackAPI
                          url: https://zapier.com/apps/slack/integrations?utm_medium=partner_api
                          label: Send Channel Message
                      title: Send messages to Slack channels whenever new Google Ads campaigns launch
                      slug: send-messages-to-slack-channels-whenever-new-google-ads-campaigns-launch
                      status: published
                      description_plain: |
                        A new Google Ads campaign can mean the start of your next marketing push, but it can also mean the start of a ton of new sales and service workflows. Zapier gives you a head start on those projects by automatically posting a new message in Slack to a specific channel you choose. Give your teams the heads up they need before your new clients come rolling in!
                      description_raw: A new Google Ads campaign can mean the start of your next marketing push, but it can also mean the start of a ton of new sales and service workflows. Zapier 
                        gives you a head start on those projects by automatically posting a new message in Slack to a specific channel you choose. Give your teams the heads up they need before your 
                        new clients come rolling in!
                      url: https://zapier.com/apps/google-ads/integrations/slack/51652/send-messages-to-slack-channels-whenever-new-google-ads-campaigns-launch?utm_medium=partner_api
                      description: |
                        <p>A new Google Ads campaign can mean the start of your next marketing push, but it can also mean the start of a ton of new sales and service workflows. Zapier gives you a head start on those projects by automatically posting a new message in Slack to a specific channel you choose. Give your teams the heads up they need before your new clients come rolling in!</p>
                      create_url: https://api.zapier.com/v1/embed/google-ads/create/51652
                      type: guided_zap
          description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/zaps:
    get:
      operationId: v1_zaps_list
      description: |-
        This endpoint returns a list of Zaps for the authenticated Zapier user.

        #### When using OAuth

        This endpoint requires the `zap` OAuth scope.
      summary: Zapier Get Zaps [v1]
      parameters:
        - in: query
          name: get_params
          schema: {}
          description: If set, guarantees that the 'params' of any node belonging to your app will be present in the response
          example: ''
        - in: query
          name: limit
          schema:
            type: number
            default: 5
          description: '(Max: 100) Limit the number of Zap templates returned.'
          example: 5
        - in: query
          name: offset
          schema:
            type: number
            default: 0
          description: The number of Zap templates to skip before beginning to return the Zap templates. The default value is 0, which is the offset of the first item.
          example: 0
        - in: query
          name: params__{{KEY}}
          schema:
            type: string
          description: Filter for Zaps that contain the given parameter's {{KEY}} and the value of the query parameter. Keys are defined by your app on the [developer 
            platform](https://zapier.com/platform/login).
          example: ex@mp1e47c4e6ff1a44e7800
      tags:
        - Zaps
      security:
        - OAuth:
            - zap
      responses:
        '403':
          description: Invalid authentication
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zaps_list401Example:
                  summary: Default v1_zaps_list 401 response
                  x-microcks-default: true
                  value: {}
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zaps_list409Example:
                  summary: Default v1_zaps_list 409 response
                  x-microcks-default: true
                  value: {}
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zaps_list429Example:
                  summary: Default v1_zaps_list 429 response
                  x-microcks-default: true
                  value: {}
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zaps_list503Example:
                  summary: Default v1_zaps_list 503 response
                  x-microcks-default: true
                  value: {}
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                V1_zaps_list504Example:
                  summary: Default v1_zaps_list 504 response
                  x-microcks-default: true
                  value: {}
          description: 504 Response
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ZapsResponse'
              examples:
                /v1/zaps:
                  value:
                    - next: https://api.zapier.com/v1/zaps?limit=2&offset=2
                      previous:
                      count: 2
                      objects:
                        - id: 125
                          title: Create Trello cards from new Typeform entries
                          state: 'on'
                          steps:
                            - type_of: read
                              app:
                                id: 4259
                                uuid: 5e2ba0e469b0-4754-bf69-d46221122aa2
                                title: Typeform
                                slug: typeform
                                description: Typeform helps you ask awesomely online! If you ever need to run a survey, questionnaire, form, contest etc... Typeform will help you achieve it 
                                  beautifully across all devices, every time, using its next generation platform.
                                hex_color: 8bcbca
                                image: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.png
                                images:
                                  url_16x16: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.16x16.png
                                  url_32x32: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.32x32.png
                                  url_64x64: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.64x64.png
                                  url_128x128: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.128x128.png
                                api: TypeformDevAPI
                                url: https://zapier.com/apps/typeform/integrations?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                              params:
                            - type_of: write
                              app:
                                id: 4192
                                uuid: ee7e5c50a7d2-4bb4-b5b8-a7e55aa00521
                                title: Trello
                                slug: trello
                                description: Trello is team collaboration tool that lets you organize anything and everything to keep your projects on task.
                                hex_color: 0079bf
                                image: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.png
                                images:
                                  url_16x16: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.16x16.png
                                  url_32x32: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.32x32.png
                                  url_64x64: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.64x64.png
                                  url_128x128: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.128x128.png
                                api: TrelloAPI
                                url: https://zapier.com/apps/trello/integrations?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                              params:
                          url: https://zapier.com/editor/125?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                          modified_at: '2017-03-22T09:38:11-05:00'
                        - id: 123
                          title: Create Trello cards from new Typeform entries
                          state: 'off'
                          steps:
                            - type_of: read
                              app:
                                id: 4259
                                uuid: 5e2ba0e469b0-4754-bf69-d46221122aa2
                                title: Typeform
                                slug: typeform
                                description: Typeform helps you ask awesomely online! If you ever need to run a survey, questionnaire, form, contest etc... Typeform will help you achieve it 
                                  beautifully across all devices, every time, using its next generation platform.
                                hex_color: 8bcbca
                                image: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.png
                                images:
                                  url_16x16: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.16x16.png
                                  url_32x32: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.32x32.png
                                  url_64x64: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.64x64.png
                                  url_128x128: https://cdn.zapier.com/storage/developer/5e21b4c1e0a2a3346a801dbc0a2a5a6d_2.128x128.png
                                api: TypeformDevAPI
                                url: https://zapier.com/apps/typeform/integrations?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                              params:
                            - type_of: write
                              app:
                                id: 4192
                                uuid: ee7e5c50a7d2-4bb4-b5b8-a7e55aa00521
                                title: Trello
                                slug: trello
                                description: Trello is team collaboration tool that lets you organize anything and everything to keep your projects on task.
                                hex_color: 0079bf
                                image: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.png
                                images:
                                  url_16x16: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.16x16.png
                                  url_32x32: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.32x32.png
                                  url_64x64: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.64x64.png
                                  url_128x128: https://cdn.zapier.com/storage/services/da3ff465abd3a3e1b687c52ff803af74.128x128.png
                                api: TrelloAPI
                                url: https://zapier.com/apps/trello/integrations?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                              params:
                          url: https://zapier.com/editor/123?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                          modified_at: '2017-03-21T22:04:05-05:00'
          description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/action-runs:
    post:
      operationId: create-action-run
      description: |-
        Runs an action (step) in the third party API, using the provided authentication and inputs.

        This endpoint is asynchronous, and the response will contain an Action Run ID. You can use the `/v2/action-runs/:id` endpoint to check the status of the run and retrieve the results.

        #### When using OAuth

        This endpoint requires the `action:run` OAuth scope.
      summary: Zapier Create an Action Run
      tags:
        - Experimental
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunActionRequest'
            examples:
              CreatingAnActionRun(runningAnAction):
                value:
                  data:
                    action: example_core:Vn7xbE60
                    authentication: example_QVaAreV1
                    inputs:
                      email: me@example.com
                summary: Creating an Action Run (running an action)
        required: true
      security:
        - OAuth:
            - action:run
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunActionResponse'
              examples:
                CreateActionRunResponse:
                  value:
                    data:
                      type: run
                      id: 123e4567-e89b-12d3-a456-426614174000
                  summary: Create Action Run Response
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-action-run403Example:
                  summary: Default create-action-run 403 response
                  x-microcks-default: true
                  value:
                    errors: &id001
                      - {}
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-action-run401Example:
                  summary: Default create-action-run 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-action-run409Example:
                  summary: Default create-action-run 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-action-run429Example:
                  summary: Default create-action-run 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-action-run503Example:
                  summary: Default create-action-run 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-action-run504Example:
                  summary: Default create-action-run 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/action-runs/{id}:
    get:
      operationId: retrieve-action-run
      description: |-
        Retrieves an Action Run.

        #### When using OAuth

        This endpoint requires the `action:run` OAuth scope.
      summary: Zapier Retrieve Action Run
      parameters:
        - in: path
          name: id
          schema:
            type: string
          description: An Action Run ID.
          required: true
          example: '500123'
      tags:
        - Experimental
      security:
        - OAuth:
            - action:run
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionRunResponse'
              examples:
                RetrievingARun:
                  value:
                    data:
                      type: run
                      status: success
                      results:
                        - id: 123
                      errors: []
                  summary: Retrieving a run
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Retrieve-action-run403Example:
                  summary: Default retrieve-action-run 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Retrieve-action-run401Example:
                  summary: Default retrieve-action-run 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Retrieve-action-run409Example:
                  summary: Default retrieve-action-run 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Retrieve-action-run429Example:
                  summary: Default retrieve-action-run 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Retrieve-action-run503Example:
                  summary: Default retrieve-action-run 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Retrieve-action-run504Example:
                  summary: Default retrieve-action-run 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/actions:
    get:
      operationId: get-actions
      description: |-
        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. Action IDs may not be reused, see our documentation for how to hardcode a particular action.

        #### When using Client ID

        Simply providing a client ID query parameter is sufficient. If an Authorization header is present, it will be used instead.

        #### When using OAuth

        This endpoint requires the `zap` OAuth scope.
      summary: Zapier Get Actions
      parameters:
        - in: query
          name: action_type
          schema:
            type: string
            enum:
              - READ
              - READ_BULK
              - SEARCH
              - SEARCH_AND_WRITE
              - SEARCH_OR_WRITE
              - WRITE
          description: The type of Action to filter for. Defaults to returning all actions regardless of type.
          example: READ
        - in: query
          name: app
          schema:
            type: string
            format: uuid
          description: A canonical App ID, as provided by the `/apps` endpoint.
          required: true
          example: 868f9d3c-2ea0-4f19-a32d-a61b276ab8de
      tags:
        - Actions
        - Apps
      security:
        - OAuth:
            - zap
        - ClientIDAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActionsResponse'
              examples:
                ActionsExample:
                  value:
                    - links:
                        next:
                        prev:
                      meta:
                        count: 1
                        limit: 10
                        offset: 0
                      data:
                        - id: uag:1f188536-6dd0-4172-8414-2b90914ddee9
                          key: new_lead
                          app: 83b47c0e-adda-44da-a45d-42565fe521ef
                          type: action
                          action_type: action
                          is_instant: true
                          title: New Lead
                          description: Triggers when a new lead is added to SuperExampleCRM
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-actions403Example:
                  summary: Default get-actions 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-actions401Example:
                  summary: Default get-actions 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-actions409Example:
                  summary: Default get-actions 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-actions429Example:
                  summary: Default get-actions 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-actions503Example:
                  summary: Default get-actions 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-actions504Example:
                  summary: Default get-actions 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/actions/{action_id}/inputs:
    post:
      operationId: get-fields-inputs
      description: |-
        Get the Input Fields for a particular Action, using the provided authentication and inputs. See the fields and fieldsets guide for more information.
        See [our docs](https://docs.zapier.com/powered-by-zapier/zap-creation/fields-and-fieldsets#input-fields) for more information.

        #### When using OAuth

        This endpoint requires the `zap:write` OAuth scope.
      summary: Zapier Get Input Fields
      parameters:
        - in: path
          name: action_id
          schema:
            type: string
          description: An Action ID, as provided by the `/actions` endpoint.
          required: true
          example: uag:87b1c14e-ef30-43d5-9395-6c6514dbb123
      tags:
        - Actions
        - Inputs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListInputFieldsRequest'
            examples:
              FetchInputFields:
                value:
                  data:
                    authentication: '928117'
                    inputs:
                      spreadsheet: my_sheet
                summary: Fetch input fields
        required: true
      security:
        - OAuth:
            - zap:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InputFieldsResponse'
              examples:
                InputFieldsForSomeApp:
                  value:
                    links:
                      next:
                      prev:
                    meta:
                      count: 2
                      limit:
                      offset: 0
                    data:
                      - type: input_field
                        id: input
                        default_value: ''
                        depends_on: []
                        description: Use the Input Data fields above to assign key names (left) and map values (right) from previous steps. Use notation `inputData.keyName` or `inputData['keyName']` 
                          to access the values within your code. The data will be provided **as strings**. Learn more 
                          [here](https://zapier.com/help/create/code-webhooks/use-javascript-code-in-zaps#input-data-for-code-steps).
                        invalidates_input_fields: false
                        is_required: false
                        placeholder: ''
                        title: Input Data
                        value_type: OBJECT
                      - type: input_field
                        id: code
                        default_value: |-
                          // this is wrapped in an `async` function
                          // you can use await throughout the function

                          output = [{id: 123, hello: "world"}];
                        depends_on: []
                        description: '**Warning! This is an advanced action!** Uses Node 10.x.x. Please read the [Code documentation for more information](/help/create/code-webhooks/use-javascript-code-in-zaps).'
                        format: CODE
                        invalidates_input_fields: false
                        is_required: true
                        placeholder: ''
                        title: Code
                        value_type: STRING
                  summary: Input fields for some app
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-inputs403Example:
                  summary: Default get-fields-inputs 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-inputs401Example:
                  summary: Default get-fields-inputs 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-inputs409Example:
                  summary: Default get-fields-inputs 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-inputs429Example:
                  summary: Default get-fields-inputs 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-inputs503Example:
                  summary: Default get-fields-inputs 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-inputs504Example:
                  summary: Default get-fields-inputs 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/actions/{action_id}/inputs/{input_id}/choices:
    post:
      operationId: get-choices
      description: |-
        Get the possible values for a `SELECT` Input Field.

        #### When using OAuth

        This endpoint requires the `zap` OAuth scope.
      summary: Zapier Get Choices
      parameters:
        - in: path
          name: action_id
          schema:
            type: string
          description: An Action ID, as provided by the `/actions` endpoint.
          required: true
          example: uag:87b1c14e-ef30-43d5-9395-6c6514dbb123
        - in: path
          name: input_id
          schema:
            type: string
          description: An Input Field ID, as provided by the `/inputs` endpoint.
          required: true
          example: lead_id
        - in: query
          name: page
          schema:
            type: string
            default: '1'
          description: The page of choices to return, defaults to the first
          example: '1'
      tags:
        - Actions
        - Inputs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChoiceRequest'
            examples:
              Get-choicesRequestExample:
                summary: Default get-choices request
                x-microcks-default: true
                value:
                  data:
                    authentication: {}
                    inputs: {}
        required: true
      security:
        - OAuth:
            - zap
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChoiceResponse'
              examples:
                ChoicesForSomeAction:
                  value:
                    - data:
                        - id: 55c
                          type: choice
                          label: First
                          value: example
                        - id: a73
                          type: choice
                          label: Second
                          value: example
                      links:
                        next:
                        prev:
                      meta:
                        page: 1
                  summary: Choices for Some Action
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-choices403Example:
                  summary: Default get-choices 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-choices401Example:
                  summary: Default get-choices 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-choices409Example:
                  summary: Default get-choices 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-choices429Example:
                  summary: Default get-choices 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-choices503Example:
                  summary: Default get-choices 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-choices504Example:
                  summary: Default get-choices 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/actions/{action_id}/outputs:
    post:
      operationId: get-fields-outputs
      description: |-
        Get the Output Fields for a particular Action, using the provided authentication and inputs.

        #### When using OAuth

        This endpoint requires the `zap:write` OAuth scope.
      summary: Zapier Get Output Fields
      parameters:
        - in: path
          name: action_id
          schema:
            type: string
          description: An Action ID, as provided by the `/actions` endpoint.
          required: true
          example: uag:87b1c14e-ef30-43d5-9395-6c6514dbb123
      tags:
        - Actions
        - Outputs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOutputFieldsRequest'
            examples:
              FetchingOutputsForSomeApp:
                value:
                  data:
                    authentication: example_QVaAreV1
                    inputs:
                      someparam: somevalue
                summary: Fetching outputs for some app
        required: true
      security:
        - OAuth:
            - zap:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutputFieldsResponse'
              examples:
                OutputFieldsForSomeApp:
                  value:
                    links:
                      next:
                      prev:
                    meta:
                      count: 3
                      limit:
                      offset: 0
                    data:
                      - type: output_fields
                        id: commit__message
                        title: Commit Message
                        sample: Git 2.0
                      - type: output_field
                        id: parents[]sha
                        title: Parents Sha
                        sample: 4a28f169ad29ba452e0e7bea2583914c10c58322
                      - type: output_field
                        id: parents[]url
                        title: Parents Url
                        sample: https://github.com/git/git/commit/4a28f169ad29ba452e0e7bea2583914c10c58322
                  summary: Output fields for some app
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-outputs403Example:
                  summary: Default get-fields-outputs 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-outputs401Example:
                  summary: Default get-fields-outputs 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-outputs409Example:
                  summary: Default get-fields-outputs 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-outputs429Example:
                  summary: Default get-fields-outputs 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-outputs503Example:
                  summary: Default get-fields-outputs 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-fields-outputs504Example:
                  summary: Default get-fields-outputs 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/actions/{action_id}/test:
    post:
      operationId: test-action
      description: |-
        Tests the action (step) in the third party api, using the provided authentication and inputs.

        #### When using OAuth

        This endpoint requires the `zap:write` OAuth scope.
      summary: Zapier Step Test
      parameters:
        - in: path
          name: action_id
          schema:
            type: string
          description: An Action ID, as provided by the `/actions` endpoint.
          required: true
          example: '500123'
      tags:
        - Actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionTestRequest'
            examples:
              TestingAnAction:
                value:
                  data:
                    limit: 10
                    offset: 0
                    authentication: example_QVaAreV1
                    inputs:
                      email: me@example.com
                summary: Testing an action
        required: true
      security:
        - OAuth:
            - zap:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionTestResponse'
              examples:
                ActionTestResponse:
                  value:
                    links:
                      next:
                      prev:
                    meta:
                      count: 1
                      limit:
                      offset: 0
                    data:
                      - Description: A response from some example third party API related to the action
                        Source: RFC 8259
                        Image:
                          Width: 800
                          Height: 600
                          Title: View from 15th Floor
                          Thumbnail:
                            Url: https://www.example.com/image/481989943
                            Height: 125
                            Width: 100
                          Animated: false
                          IDs:
                            - 116
                            - 943
                            - 234
                            - 38793
                  summary: Action Test Response
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Test-action403Example:
                  summary: Default test-action 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Test-action401Example:
                  summary: Default test-action 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Test-action409Example:
                  summary: Default test-action 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Test-action429Example:
                  summary: Default test-action 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Test-action503Example:
                  summary: Default test-action 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Test-action504Example:
                  summary: Default test-action 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/apps:
    get:
      operationId: get-v2-apps
      description: |-
        This endpoint returns a list of apps sorted by popularity.

        #### When using Client ID

        Simply providing a client ID query parameter is sufficient. If an Authorization header is present, it will be used instead.

        #### When using OAuth

        This endpoint requires the `zap` OAuth scope.
      summary: Zapier Get Apps [v2]
      parameters:
        - in: query
          name: category
          schema:
            type: string
          description: "Categories that apps must have in order to be returned in the response. \nThe full list of valid categories can be retrieved using the `category` endpoint, detailed [here](https://platform.zapier.com/embed/partner-api#get-v1categories)."
          example: ai-tools
        - in: query
          name: ids
          schema:
            type: string
          description: Parameter to restrict the results to apps whose ID matches those in the provided comma-separated value. Cannot be combined with `category`.
          example: example-value
        - in: query
          name: limit
          schema:
            type: integer
          description: Used for paginating results. Specifies the maximum number of items to return per page. If this value is not set, it defaults to 10.
          example: 10
        - in: query
          name: offset
          schema:
            type: integer
          description: Used for paginating results. Specifies the offset to use.
          example: 100
        - in: query
          name: query
          schema:
            type: string
          description: Parameter to limit the results to apps whose titles match the provided query.
          example: example-value
      tags:
        - Apps
      security:
        - OAuth:
            - zap
        - ClientIDAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExpandedAppsResponse'
              examples:
                /v2/apps:
                  value:
                    - data:
                        - 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
                          action_types:
                            - READ
                          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: partners
                          description: HubSpot is your all-in-one stop for all of your marketing software needs.
                      meta:
                        count: 1
                        offset: 10
                        limit: 10
                      links:
                        next: https://api.zapier.com/v2/apps?offset=20&limit=10
                        previous: https://api.zapier.com/v2/apps?offset=0&limit=10
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-apps403Example:
                  summary: Default get-v2-apps 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-apps401Example:
                  summary: Default get-v2-apps 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-apps409Example:
                  summary: Default get-v2-apps 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-apps429Example:
                  summary: Default get-v2-apps 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-apps503Example:
                  summary: Default get-v2-apps 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-apps504Example:
                  summary: Default get-v2-apps 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/authentications:
    get:
      operationId: get-authentications
      description: |-
        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.

        #### When using OAuth

        This endpoint requires the `connection:read` OAuth scope.
      summary: Zapier Get Authentications
      parameters:
        - in: query
          name: app
          schema:
            type: string
            format: uuid
          description: A canonical App ID, as provided by the `/apps` endpoint.
          required: true
          example: 868f9d3c-2ea0-4f19-a32d-a61b276ab8de
        - in: query
          name: limit
          schema:
            type: integer
          description: Used for paginating results. Specifies the maximum number of items to return per page. If this value is not set, it defaults to 10.
          example: 10
        - in: query
          name: offset
          schema:
            type: integer
          description: Used for paginating results. Specifies the offset to use.
          example: 100
      tags:
        - Authentications
      security:
        - OAuth:
            - connection:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationResponse'
              examples:
                AuthenticationsForGoogleSheets:
                  value:
                    links:
                      next:
                      prev:
                    meta:
                      count: 1
                      limit: 10
                      offset: 0
                    data:
                      - type: authentication
                        id: example_akLLd8kB
                        app: 81f613aa-c98a-4383-a5fc-195e68647217
                        is_expired: false
                        title: Google Sheets some.user@mycompany.example
                  summary: Authentications for Google Sheets
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-authentications403Example:
                  summary: Default get-authentications 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-authentications401Example:
                  summary: Default get-authentications 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-authentications409Example:
                  summary: Default get-authentications 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-authentications429Example:
                  summary: Default get-authentications 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-authentications503Example:
                  summary: Default get-authentications 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-authentications504Example:
                  summary: Default get-authentications 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: create-authentication
      description: |-
        Creates a new Authentication for the provided App. See our Adding an Authentication guide to get started.

        #### When using OAuth

        This endpoint requires the `connection:write` OAuth scope.
      summary: Zapier Create Authentication
      tags:
        - Authentications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationCreateRequest'
            examples:
              NewAuthentication:
                value:
                  data:
                    title: My new auth
                    app: 8cdbc496-c95c-4f19-b3a3-fee03ed5f924
                    authentication_fields:
                      secret: example_E4CrHVvRuxTXrPFLyyZFeRJwJcx2ELQZ
                summary: New Authentication
        required: true
      security:
        - OAuth:
            - connection:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationResponse'
              examples:
                CreatedAuth:
                  value:
                    links:
                      next:
                      prev:
                    meta:
                      count: 1
                      limit: 1
                      offset: 0
                    data:
                      - type: authentication
                        id: example_DOb4nWkz
                        app: a8aaed31-e257-4479-aaa9-ca02fe2fab04
                        is_expired: false
                        title: 'Example zapier@example.com #5'
                  summary: Created Auth
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-authentication403Example:
                  summary: Default create-authentication 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-authentication401Example:
                  summary: Default create-authentication 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-authentication409Example:
                  summary: Default create-authentication 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-authentication429Example:
                  summary: Default create-authentication 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-authentication503Example:
                  summary: Default create-authentication 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-authentication504Example:
                  summary: Default create-authentication 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/authorize:
    get:
      operationId: v2_authorize_list
      description: Create a new user and obtain an access token. See our Quick Account Creation guide to get started.
      summary: Zapier Create Account
      parameters:
        - in: query
          name: client_id
          schema:
            type: string
            minLength: 1
          description: Your application Client ID.
          required: true
          example: '500123'
        - in: query
          name: redirect_uri
          schema:
            type: string
            minLength: 1
          description: The page the user will be redirect to after OAuth flow.
          required: true
          example: https://example.com/path/abc123
        - in: query
          name: referer
          schema:
            type: string
            minLength: 1
          example: example-value
        - in: query
          name: response_type
          schema:
            type: string
            minLength: 1
          description: Only OAuth response type `code` is supported
          required: true
          example: standard
        - in: query
          name: scope
          schema:
            type: string
            minLength: 1
          description: Space (`%20`) separated values
          required: true
          example: example-value
        - in: query
          name: sign_up_email
          schema:
            type: string
            format: email
            minLength: 1
          description: Email of the user signing up.
          example: user@example.com
        - in: query
          name: sign_up_first_name
          schema:
            type: string
            minLength: 1
          description: First name of the user signing up.
          example: Example Name
        - in: query
          name: sign_up_last_name
          schema:
            type: string
            minLength: 1
          description: Last name of the user signing up.
          example: Example Name
        - in: query
          name: utm_campaign
          schema:
            type: string
            default: workflow_api
            minLength: 1
          example: workflow_api
        - in: query
          name: utm_content
          schema:
            type: string
            minLength: 1
          example: example-value
        - in: query
          name: utm_medium
          schema:
            type: string
            default: embed
            minLength: 1
          example: embed
        - in: query
          name: utm_source
          schema:
            type: string
            default: partner
            minLength: 1
          example: partner
      tags:
        - Accounts
      security:
        - ClientIDAuthentication: []
      responses:
        '302':
          description: Redirect to authorization URL
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2_authorize_list403Example:
                  summary: Default v2_authorize_list 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2_authorize_list401Example:
                  summary: Default v2_authorize_list 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2_authorize_list409Example:
                  summary: Default v2_authorize_list 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2_authorize_list429Example:
                  summary: Default v2_authorize_list 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2_authorize_list503Example:
                  summary: Default v2_authorize_list 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2_authorize_list504Example:
                  summary: Default v2_authorize_list 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/guess:
    post:
      operationId: create-zap-guess
      description: This endpoint returns a suggested Zap and pre-filled URL to Zapier from a given prompt.
      summary: Zapier Guess a Zap [Beta]
      parameters:
        - in: query
          name: client_id
          schema:
            type: string
          description: See our authentication documentation for how to find your client ID
          required: true
          example: '500123'
      tags:
        - Zaps
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZapGuesserRequest'
            examples:
              ZapGuessRequest:
                value:
                  description: Save new leads from Facebook Lead Ads to Google Sheets, and email me the lead in Gmail
                summary: Zap Guess Request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZapGuesserResponse'
              examples:
                ZapGuessResponse:
                  value:
                    title: Save Facebook Lead Ads leads to Google Sheets and send an email
                    steps:
                      - step:
                          title: Trigger when a new lead is created in Facebook Lead Ads
                          app: Facebook Lead Ads
                          api: FacebookLeadsAPI
                        alternatives:
                          - title:
                            app: LinkedIn Ads
                            api: LinkedInLeadGenFormsCLIAPI@2.7.1
                      - step:
                          title: Save the lead information to a Google Sheet
                          app: Google Sheets
                          api: GoogleSheetsV2API
                        alternatives: []
                    prefilled_url: 
                      https://api.zapier.com/v1/embed/my-app/create?steps%5B0%5D%5Bapp%5D=FacebookLeadsAPI&steps%5B0%5D%5Baction%5D=lead&steps%5B0%5D%5Btype%5D=read&steps%5B1%5D%5Bapp%5D=GoogleSheetsV2API&steps%5B1%5D%5Baction%5D=add_row&steps%5B1%5D%5Btype%5D=write&utm_campaign=partner_zap_guesser&copilot_prompt=Save+new+leads+from+Facebook+Lead+Ads+to+Google+Sheets%2C+and+email+me+the+lead+in+Gmail&partner_zap_guesser_attempt_id=22f44602-db8f-4a2a-8b09-420b0d277b5f
                  summary: Zap Guess Response
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-zap-guess403Example:
                  summary: Default create-zap-guess 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-zap-guess401Example:
                  summary: Default create-zap-guess 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-zap-guess409Example:
                  summary: Default create-zap-guess 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-zap-guess429Example:
                  summary: Default create-zap-guess 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-zap-guess503Example:
                  summary: Default create-zap-guess 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Create-zap-guess504Example:
                  summary: Default create-zap-guess 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidZapGuesserResponse'
              examples:
                InvalidGuessAZapPrompt:
                  value:
                    messages:
                      - detail: This doesn't seem to be a workflow. You could try something like, 'When a new NFL...
                  summary: Invalid Guess a Zap Prompt
          description: This schema can be expected for 400 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/whitelabel/apps:
    get:
      operationId: v2-whitelabel-apps-list
      description: This endpoint returns a list of apps available for whitelabel connection. It is only for customers enrolled in the Zapier Whitelabel program. All others likely want the `Get Apps` 
        endpoint instead.
      summary: Zapier Get Whitelabel Apps [v2]
      parameters:
        - in: query
          name: category
          schema:
            type: string
          description: Filter apps by category slug.
          example: standard
        - in: query
          name: limit
          schema:
            type: number
          description: Limit the number of apps returned.
          example: 42.5
        - in: query
          name: offset
          schema:
            type: number
            default: 0
          description: The number of apps to skip before beginning to return results.
          example: 0
        - in: query
          name: search
          schema:
            type: string
          description: Case-insensitive search to filter apps by title.
          example: example-value
      tags:
        - Apps
        - Experimental
      responses:
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2-whitelabel-apps-list403Example:
                  summary: Default v2-whitelabel-apps-list 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2-whitelabel-apps-list401Example:
                  summary: Default v2-whitelabel-apps-list 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2-whitelabel-apps-list409Example:
                  summary: Default v2-whitelabel-apps-list 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2-whitelabel-apps-list429Example:
                  summary: Default v2-whitelabel-apps-list 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2-whitelabel-apps-list503Example:
                  summary: Default v2-whitelabel-apps-list 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                V2-whitelabel-apps-list504Example:
                  summary: Default v2-whitelabel-apps-list 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WhitelabelAppsResponse'
              examples:
                V2-whitelabel-apps-list200Example:
                  summary: Default v2-whitelabel-apps-list 200 response
                  x-microcks-default: true
                  value:
                    - data: &id002
                        - {}
                      links: &id003 {}
                      meta: &id004 {}
          description: ''
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/zap-runs:
    get:
      operationId: get-zap-runs
      description: |-
        This endpoint returns runs for the specified Zaps and provides basic yet essential details about their execution. As the initial version, it serves foundational information, with plans for continuous enhancement to expand its capabilities and improve data output over time.

        #### When using OAuth

        This endpoint requires the `zap:runs` OAuth scope.
      summary: Zapier Get Zap Runs
      parameters:
        - in: query
          name: from_date
          schema:
            type: string
          description: Filter Zap runs that occurred on or after this date. If not provided, the results default to Zap runs from the last 30 days.
          example: '2024-10-16T06:29:10.360000Z'
        - in: query
          name: limit
          schema:
            type: integer
          description: Used for paginating results. Specifies the maximum number of items to return per page. If this value is not set, it defaults to 10.
          example: 10
        - in: query
          name: offset
          schema:
            type: integer
          description: Used for paginating results. Specifies the offset to use.
          example: 100
        - in: query
          name: search
          schema:
            type: string
          description: Performs a text search against the zap_title, data_in, and data_out fields, returning only zap runs that match the specified keywords.
          x-maxLength: 150
          example: My Zap Title
        - in: query
          name: statuses
          schema:
            type: array
            items:
              type: string
              enum:
                - delayed
                - scheduled
                - pending
                - error
                - error_handled
                - halted
                - throttled
                - held
                - filtered
                - skipped
                - success
          description: Accepts one or more status values separated by comma, enabling the filtering of zap runs based on the specified status or statuses provided.
          explode: false
          style: form
          example:
            - error
            - success
        - in: query
          name: to_date
          schema:
            type: string
          description: Filter Zap runs that occurred before this date.
          example: '2024-10-16T06:29:10.360000Z'
        - in: query
          name: zap_id
          schema:
            type: integer
          description: Find Zap runs for the specified Zap ID.
          example: 104445735
      tags:
        - Experimental
        - Zaps
      security:
        - OAuth:
            - zap:runs
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ZapRunsResponse'
              examples:
                /v2/zap-runs:
                  value:
                    - links:
                        next: https://api.zapier.com/v2/zap-runs?offset=10&limit=10
                        prev: https://api.zapier.com/v2/zap-runs?offset=0&limit=10
                      meta:
                        count: 30
                        limit: 10
                        offset: 10
                      data:
                        - id: 123e4567-e89b-12d3-a456-426614174000
                          zap_id: 104445735
                          start_time: '2024-10-16T06:29:10.360000Z'
                          end_time: '2024-10-16T06:29:10.360000Z'
                          status: success
                          zap_title: My Awesome Zap
                          steps:
                            - status: success
                              start_time: '2024-10-16T06:29:10.360000Z'
                          data_in: ''
                          data_out: ''
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-zap-runs403Example:
                  summary: Default get-zap-runs 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-zap-runs401Example:
                  summary: Default get-zap-runs 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-zap-runs409Example:
                  summary: Default get-zap-runs 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-zap-runs429Example:
                  summary: Default get-zap-runs 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-zap-runs503Example:
                  summary: Default get-zap-runs 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-zap-runs504Example:
                  summary: Default get-zap-runs 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v2/zaps:
    get:
      operationId: get-v2-zaps
      description: |-
        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.

        #### When using OAuth

        This endpoint requires the `zap`, `zap:all`, or `zap:account:all` OAuth scopes.
      summary: Zapier Get Zaps [v2]
      parameters:
        - in: query
          name: expand
          schema:
            type: string
          description: 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.
          example: steps.action
        - in: query
          name: include_shared
          schema:
            type: boolean
          description: 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.
          example: true
        - in: query
          name: inputs
          schema:
            type: string
          description: 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.
          example: inputs[board]=BOARD_ID
        - in: query
          name: limit
          schema:
            type: integer
          description: Used for paginating results. Specifies the maximum number of items to return per page. If this value is not set, it defaults to 10.
          example: 10
        - in: query
          name: offset
          schema:
            type: integer
          description: Used for paginating results. Specifies the offset to use.
          example: 100
      tags:
        - Zaps
      security:
        - OAuth:
            - zap
            - zap:all
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExpandedZapsResponse'
              examples:
                /v2/zaps:
                  value:
                    - links:
                        next:
                        prev:
                      meta:
                        count: 1
                        offset: 0
                        limit:
                      data:
                        - type: zap
                          id: 00000000-0000-c000-8000-000000012345
                          is_enabled: false
                          last_successful_run_date: '2019-08-24T14:15:22Z'
                          updated_at: '2019-08-24T14:15:22Z'
                          title: My Zap
                          links:
                            html_editor: https://zapier.com/editor/7481?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                          steps:
                            - action: uag:1f188536-6dd0-4172-8414-2b90914ddee9
                              authentication: QVaPP2O1
                              inputs:
                                deal_stage: CLOSED_WON
                              title: Pacific Railway Golden spike hammered
                            - action: uag:1f188536-6dd0-4172-8414-2b90914ddaa7
                              authentication: MVA64zk4
                              inputs:
                                full_name: '{{customer__full_name}}'
                              title: Record who dunnit
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-zaps403Example:
                  summary: Default get-v2-zaps 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-zaps401Example:
                  summary: Default get-v2-zaps 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-zaps409Example:
                  summary: Default get-v2-zaps 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-zaps429Example:
                  summary: Default get-v2-zaps 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-zaps503Example:
                  summary: Default get-v2-zaps 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Get-v2-zaps504Example:
                  summary: Default get-v2-zaps 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: post-zaps
      description: |-
        This URL creates a Zap based on the given steps and title.

        #### When using OAuth

        This endpoint requires the `zap:write` OAuth scope.
      summary: Zapier Create a Zap
      parameters:
        - in: query
          name: expand
          schema:
            type: string
          description: 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.
          example: steps.action
      tags:
        - Zaps
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZapRequest'
            examples:
              ToBeCreatedZap:
                value:
                  data:
                    steps:
                      - action: example_core:5m2y9p7J
                        inputs:
                          code: 'output = [{id: Math.round(Date.now()/1000), n: Math.random()}];'
                        authentication:
                        alias:
                      - action: example_core:VBz2NGB5
                        inputs:
                          code: 'output = [{ id: inputData.id, n: inputData.n * 2}];'
                          inputs:
                            n: '{{n}}'
                            id: '{{id}}'
                        authentication:
                        alias:
                    title: My Critically Important Program
                summary: To be created Zap
              ManyStepZap:
                value:
                  data:
                    steps:
                      - action: core:9QKqnTZ54VnrL2opYbkJJKveKEr2GJ
                        inputs: {}
                        authentication: Vx4PEEeV
                        alias: slack_new_saved_message
                      - action: core:2oY5MSxlgML1jb43A0nroedgjdnVM
                        inputs:
                          to:
                            - chang.hsiao@irohalen.example
                          subject: 3 step zap - new message saved in slack
                          body: |-
                            Saved new message from:
                            {{slack_new_saved_message.user__real_name}}


                            Message Content:
                            {{text}}
                        authentication: k0QBMMDK
                        alias:
                      - action: core:vDakLS1PLO4J29eodDRLa5okErEn0
                        inputs:
                          channel: U036ZHWNHU2
                          text: |-
                            Saved new message from:
                            {{slack_new_saved_message.user__real_name}}


                            Email thread id:
                            {{threadId}}


                            Message Content:
                            {{slack_new_saved_message.text}}
                        authentication: Vx4PEEeV
                        alias: slack_send_direct_message
                    title: My 3 step zap
                summary: Many Step Zap
        required: true
      security:
        - OAuth:
            - zap:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedZap'
              examples:
                CustomCreatedZap:
                  value:
                    type: zap
                    id: 033cc069f2d3-4d63-8666-10c07ab38dac
                    is_enabled: true
                    last_successful_run_date: '2019-08-24T14:15:22Z'
                    updated_at: '2024-03-14T22:02:36+00:00'
                    title: My Critically Important Program
                    links:
                      html_editor: https://zapier.com/editor/104826178?utm_source=partner&utm_medium=embed&utm_campaign=partner_api&referer=zapier
                    steps:
                      - action: example_core:Vn7xbE60
                        authentication: 2kyXZ8VJ
                        inputs: {}
                        title:
                      - action: example_core:V7GpzX40
                        authentication:
                        inputs:
                        title:
                  summary: Custom created zap
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Post-zaps403Example:
                  summary: Default post-zaps 403 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 403 Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Post-zaps401Example:
                  summary: Default post-zaps 401 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 401 Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Post-zaps409Example:
                  summary: Default post-zaps 409 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 409 Response
        '429':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Post-zaps429Example:
                  summary: Default post-zaps 429 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 429 Response
        '503':
          headers:
            Retry-After:
              schema:
                type: string
                format: uri
              description: Indicates when to retry the request
            X-RateLimit-Limit:
              schema:
                type: string
                format: uri
              description: The maximum number of requests you're permitted to make per hour.
            X-RateLimit-Remaining:
              schema:
                type: string
                format: uri
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: string
                format: uri
              description: The time at which the current rate limit window resets in UTC epoch seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Post-zaps503Example:
                  summary: Default post-zaps 503 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Post-zaps504Example:
                  summary: Default post-zaps 504 response
                  x-microcks-default: true
                  value:
                    errors: *id001
          description: 504 Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                MalformedRequest.:
                  value:
                    errors:
                      - status: 400
                        code: parse_error
                        title: ParseError
                        detail: Malformed request.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: Malformed request.
                            code: parse_error
                  summary: Malformed request.
          description: This schema can be expected for 4xx 'Malformed request.' errors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AServerErrorOccurred.:
                  value:
                    errors:
                      - status: 500
                        code: error
                        title: APIException
                        detail: A server error occurred.
                        source:
                        meta:
                          source: ZAPIER
                          full_details:
                            message: A server error occurred.
                            code: error
                  summary: A server error occurred.
          description: This schema can be expected for 5xx 'A server error occurred.' errors
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Action:
      type: object
      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.
      properties:
        id:
          type: string
          description: The ID to refer to this action (unstable, may change when referenced app changes)
          example: '500123'
        key:
          type: string
          description: The developer provided identifier for this Action (stable)
          example: example-value
        app:
          description: Apps
          oneOf:
            - $ref: '#/components/schemas/Apps'
            - type: string
          example: example-value
        type:
          allOf:
            - $ref: '#/components/schemas/ActionTypeEnum'
          description: |-
            The type of this object

            * `action` - action
          example: standard
        action_type:
          allOf:
            - $ref: '#/components/schemas/ActionTypeEnum'
          description: |-
            The type of this Action

            * `READ` - READ
            * `READ_BULK` - READ_BULK
            * `WRITE` - WRITE
            * `SEARCH` - SEARCH
            * `SEARCH_OR_WRITE` - SEARCH_OR_WRITE
            * `SEARCH_AND_WRITE` - SEARCH_AND_WRITE
            * `FILTER` - FILTER
          example: standard
        is_instant:
          type: boolean
          description: Will be set to `true` if this Action triggers instantly. May only be `true` when `type` is `READ`.
          example: true
        title:
          type: string
          description: The title of this Action.
          example: Example Name
        description:
          type: string
          description: A longer description of this Action, usually describing what it does in more detail.
          example: Example description for this resource.
      required:
        - action_type
        - app
        - description
        - id
        - is_instant
        - key
        - title
        - type
    ActionRunResponse:
      type: object
      description: The response of a given Action Run
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/_ActionRunResponse'
          description: The resulting data after a given Action was run
          example: example-value
      required:
        - data
    ActionTestRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/_ActionTestRequest'
      required:
        - data
    ActionTestResponse:
      type: object
      description: |-
        Base Response definition to be used in other Response Serializers.

        Be sure to include the `data` field after using this class
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: The links object returned in paginated response bodies.
          example: example-value
        meta:
          allOf:
            - $ref: '#/components/schemas/BaseMeta'
          description: The meta object returned in paginated response bodies.
          example: example-value
        data:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: The result of executing said Action on the third-party API
          example:
            - {}
      required:
        - data
        - links
        - meta
    ActionTypeEnum:
      enum:
        - action
      type: string
      description: '* `action` - action'
    ActionsResponse:
      type: object
      description: A valid response for fetching available actions for the App
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: The links object returned in paginated response bodies.
          example: example-value
        meta:
          allOf:
            - $ref: '#/components/schemas/BaseMeta'
          description: The meta object returned in paginated response bodies.
          example: example-value
        data:
          type: array
          items:
            $ref: '#/components/schemas/Action'
          description: List of Actions for the provided App
          example:
            - {}
      required:
        - links
        - meta
    App:
      type: object
      description: App (Service).
      properties:
        uuid:
          type: string
          format: uuid
          description: The UUID identifier of this App
          example: 550e8400-e29b-41d4-a716-446655440000
        title:
          type: string
          description: The title of this App
          example: Example Name
        slug:
          type: string
          description: The shortened slug identified of this App
          pattern: ^[-a-zA-Z0-9_]+$
          example: example-value
        description:
          type: string
          description: The description of this App
          example: Example description for this resource.
        image:
          type: string
          format: uri
          description: A URL to an image representing this App
          example: https://example.com/path/abc123
        url:
          type: string
          readOnly: true
          description: A URL to an embed with your App and this one
          example: https://example.com/path/abc123
        links:
          type: object
          additionalProperties:
            type: string
          readOnly: true
          description: An object whose 'mutual:zap_templates' key is a URL to shared Zap Templates between your App and this one
          example: {}
        categories:
          type: array
          items:
            $ref: '#/components/schemas/Category'
          description: A list of Categories associated with this App
          example:
            - {}
        images:
          type: object
          additionalProperties: {}
          description: An object containing images representing this App of various sizes
          example: {}
        app_latest:
          type: string
          readOnly: true
          description: Shorthand for referencing the latest version of this App
          example: example-value
      required:
        - app_latest
        - categories
        - description
        - image
        - images
        - links
        - slug
        - title
        - url
        - uuid
    AppCategory:
      type: object
      description: Category an app belongs to.
      properties:
        id:
          type: integer
          description: The unique ID for this Category
          example: 100
        title:
          type: string
          description: The title of this Category
          example: Example Name
        slug:
          type: string
          description: The shortened slug for this Category
          example: example-value
        description:
          type: string
          description: The description of this Categeory
          example: Example description for this resource.
        url:
          type: string
          description: The URL for this Category
          example: https://example.com/path/abc123
        type_of:
          type: string
          description: The type of this Category
          example: standard
        featured_entry_slug:
          type:
            - string
            - 'null'
          description: The featured entry for this Category (if present)
          example: example-value
        role:
          type: string
          description: This Category's role
          example: example-value
      required:
        - description
        - featured_entry_slug
        - id
        - role
        - slug
        - title
        - type_of
        - url
    Apps:
      type: object
      description: An app that integrates with Zapier
      properties:
        id:
          type: string
          description: Unique id of the app
          example: '500123'
        type:
          type: string
          default: app
          description: The type of this object.
          example: app
        image:
          type: string
          description: Default image/icon to represent the app.
          example: example-value
        links:
          type: object
          additionalProperties: {}
          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.

                        If value is `null`, then no authentication is required to use the app. Client ID-authenticated requests will never have this object's fields populated.
          example: {}
        action_types:
          type: array
          items: {}
          description: A list of action types for this specific App
          example:
            - standard
        title:
          type: string
          description: Human readable name of the app
          example: Example Name
        images:
          allOf:
            - $ref: '#/components/schemas/AppsImages'
          description: The URL of images (of various sizes) for this specific App
          example: example-value
        hex_color:
          type: string
          description: A branded color that can be used to represent the app.
          example: example-value
        categories:
          type: array
          items:
            $ref: '#/components/schemas/Category'
          description: A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.
          example:
            - {}
        description:
          type: string
          description: Human readable description of the app.
          example: Example description for this resource.
      required:
        - action_types
        - categories
        - description
        - hex_color
        - id
        - image
        - images
        - links
        - title
    AppsImages:
      type: object
      description: Images/icons of various resolutions to represent the app.
      properties:
        url_16x16:
          type: string
          description: 16x16 resolution image URL
          example: example-value
        url_32x32:
          type: string
          description: 32x32 resolution image URL
          example: example-value
        url_64x64:
          type: string
          description: 64x64 resolution image URL
          example: example-value
        url_128x128:
          type: string
          description: 128x128 resolution image URL
          example: example-value
      required:
        - url_128x128
        - url_16x16
        - url_32x32
        - url_64x64
    AppsResponse:
      type: object
      description: A page of returned apps.
      properties:
        total:
          type: integer
          description: The total number of Apps that matched
          example: 100
        page:
          type: integer
          readOnly: true
          description: The current page returned
          example: 100
        pages:
          type: integer
          readOnly: true
          description: The total number of pages
          example: 100
        per_page:
          type: integer
          readOnly: true
          description: How many Apps are returned per-page
          example: 100
        objects:
          type: array
          items:
            $ref: '#/components/schemas/App'
          description: A list containing all matching Apps'
          example:
            - {}
        prev_url:
          type: string
          format: uri
          readOnly: true
          description: The URL to call to get the previous matching Apps
          example: https://example.com/path/abc123
        next_url:
          type: string
          format: uri
          readOnly: true
          description: The URL to call to get the next matching Apps
          example: https://example.com/path/abc123
      required:
        - next_url
        - objects
        - page
        - pages
        - per_page
        - prev_url
        - total
    Authentication:
      type: object
      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
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/AuthenticationTypeEnum'
          readOnly: true
          default: authentication
          description: |-
            The type of this object.

            * `authentication` - authentication
          example: authentication
        id:
          type: string
          description: The identifier for this specific Authentication
          example: '500123'
        app:
          description: An app that integrates with Zapier.
          oneOf:
            - $ref: '#/components/schemas/Apps'
            - type: string
          example: example-value
        is_expired:
          type: boolean
          description: If `true`, this Authentication has expired. It will not be usable, and the user needs to be directed to reconnect it.
          example: true
        title:
          type: string
          description: The title of this specific Authentication
          example: Example Name
      required:
        - app
        - id
        - is_expired
        - title
        - type
    AuthenticationCreateRequest:
      type: object
      description: Inputs to create a new Authentication
      properties:
        data:
          $ref: '#/components/schemas/_AuthenticationCreateRequest'
      required:
        - data
    AuthenticationResponse:
      type: object
      description: |-
        Base Response definition to be used in other Response Serializers.

        Be sure to include the `data` field after using this class
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: The links object returned in paginated response bodies.
          example: example-value
        meta:
          allOf:
            - $ref: '#/components/schemas/BaseMeta'
          description: The meta object returned in paginated response bodies.
          example: example-value
        data:
          type: array
          items:
            $ref: '#/components/schemas/Authentication'
          description: The Authentications present, provided they exist
          example:
            - {}
      required:
        - links
        - meta
    AuthenticationTypeEnum:
      enum:
        - authentication
      type: string
      description: '* `authentication` - authentication'
    BaseMeta:
      type: object
      description: The meta object returned in paginated response bodies.
      properties:
        count:
          type: integer
          minimum: 0
          description: The total number of objects in the collection represented by the endpoint.
          example: 100
        limit:
          type:
            - integer
            - 'null'
          minimum: 1
          description: The limit value used in the request.
          example: 100
        offset:
          type: integer
          minimum: 0
          default: 0
          description: The offset value used in the request.
          example: 0
      required:
        - count
        - limit
    CategoriesResponse:
      type: object
      description: A page of returned Categories.
      properties:
        next:
          type:
            - string
            - 'null'
          format: uri
          readOnly: true
          description: The URL to call to get the next set of Categories
          example: https://example.com/path/abc123
        previous:
          type:
            - string
            - 'null'
          format: uri
          readOnly: true
          description: The URL to call to get the prior set of Categories
          example: https://example.com/path/abc123
        count:
          type: integer
          description: How many Categories exist for the given query
          example: 100
        objects:
          type: array
          items:
            $ref: '#/components/schemas/AppCategory'
          description: The list of matching Category data
          example:
            - {}
      required:
        - count
        - next
        - objects
        - previous
    Category:
      type: object
      description: Category an app belongs to.
      properties:
        slug:
          type: string
          description: The shortened slug name for this category
          example: example-value
      required:
        - slug
    Choice:
      type: object
      description: A single element from a set of Choices, variants in an enumeration.
      properties:
        id:
          type: string
          description: The ID of this variant
          example: '500123'
        type:
          type: string
          description: The type of this object
          example: standard
        label:
          type:
            - string
            - 'null'
          description: An optional human-readable label for this variant. Useful if the actual value is not a human-readable value, such as an identifier.
          example: Example Name
        value:
          type: string
          description: The value of this variant.
          example: example-value
      required:
        - id
        - type
        - value
    ChoiceParams:
      type: object
      description: A Choice as to be provided to the /choices endpoint
      properties:
        authentication:
          type:
            - string
            - 'null'
          description: The Authentication ID for this Choice, if present/required
          example: example-value
        inputs:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: The Inputs for this Choice, if present/required
          example: {}
      required:
        - authentication
        - inputs
    ChoiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ChoiceParams'
      required:
        - data
    ChoiceResponse:
      type: object
      description: A successful response for getting the requested Input Fields.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Choice'
          description: A list of Choices matching the given request
          example:
            - {}
        links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: The links object returned in paginated response bodies.
          example: example-value
        meta:
          allOf:
            - $ref: '#/components/schemas/Meta'
          description: The meta object returned in paginated response bodies.
          example: example-value
      required:
        - links
        - meta
    CodeEnum:
      enum:
        - user
        - authentication
        - partner
        - system
        - throttled
        - system_throttled
        - hydration
      type: string
      description: |-
        * `user` - user
        * `authentication` - authentication
        * `partner` - partner
        * `system` - system
        * `throttled` - throttled
        * `system_throttled` - system_throttled
        * `hydration` - hydration
    CreateZapRequest:
      type: object
      description: See our Building a Zap guide to get started.
      properties:
        steps:
          type: array
          items:
            $ref: '#/components/schemas/CreateZapRequestStep'
          description: The list of steps that the Zap should consist of
          example:
            - {}
        title:
          type: string
          description: The title to be set for this Zap
          example: Example Name
      required:
        - steps
        - title
    CreateZapRequestStep:
      type: object
      properties:
        action:
          type: string
          description: The ID of the Action to be associated with this step
          example: example-value
        inputs:
          type: object
          additionalProperties: {}
          description: The inputs for the Action associated with this step
          example: {}
        authentication:
          type:
            - string
            - 'null'
          description: The authentication, if required, for this Action to run
          example: example-value
        alias:
          type:
            - string
            - 'null'
          description: Optional alias for this step to be referenced by later steps (snake_case, max 64 chars)
          maxLength: 64
          pattern: ^[a-z][a-z0-9_]*$
          example: example-value
      required:
        - action
        - authentication
        - inputs
    Error:
      type: object
      description: Base Error definition
      properties:
        status:
          type: integer
          description: The HTTP status code applicable to this problem.
          example: 100
        code:
          type: string
          description: A unique identifier for this particular occurrence of the problem.
          example: example-value
        title:
          type: string
          description: A short summary of the problem.
          example: Example Name
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          example: example-value
        source:
          oneOf:
            - $ref: '#/components/schemas/ErrorSource'
            - type: 'null'
          description: An object containing references to the primary source of the error.
          example: example-value
        meta:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: Freeform metadata about the error
          example: {}
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: An array of error objects.
          example: *id001
      required:
        - errors
    ErrorSource:
      type: object
      description: Populates the `source` object inside our error responses.
      properties:
        pointer:
          type: string
          description: Pointer to the value in the request document that caused the error e.g. `/actions`.
          example: example-value
        parameter:
          type: string
          description: A string indicating which URI query parameter caused the error.
          example: example-value
        header:
          type: string
          description: A string indicating the name of a single request header which caused the error.
          example: example-value
    ExpandedAppsResponse:
      type: object
      description: An app that integrates with Zapier.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Apps'
          description: A list of the Apps matching the request
          example:
            - {}
        meta:
          type:
            - object
            - 'null'
          additionalProperties: {}
          readOnly: true
          description: Used for paginating results. Specifies the maximum number of items to return per page.
          example: {}
        links:
          type:
            - object
            - 'null'
          additionalProperties: {}
          readOnly: true
          description: Used for paginating results. Specifies the offset to use. Defaults to 0
          example: {}
      required:
        - data
        - links
        - meta
    ExpandedZap:
      type: object
      description: A Zap is an automated workflow that connects your apps and services together.
      properties:
        type:
          type: string
          readOnly: true
          description: The type of this object.
          example: standard
        id:
          type: string
          readOnly: true
          description: A unique identifier of the Zap.
          example: '500123'
        is_enabled:
          type: boolean
          default: true
          description: Whether the Zap is enabled (running) or not.
          example: true
        last_successful_run_date:
          type:
            - string
            - 'null'
          readOnly: true
          description: The date/time at which this Zap last ran successfully. A null value indicates that a Zap has never run successfully.
          example: example-value
        updated_at:
          type: string
          readOnly: true
          description: The last time this Zap was updated
          example: example-value
        title:
          type: string
          description: The human readable name of the Zap.
          example: Example Name
        links:
          type: object
          additionalProperties: {}
          readOnly: true
          description: Link to open this Zap in the Zapier Editor
          example: {}
        steps:
          description: A list of the steps this Zap consists of
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/ExpandedZapStep'
              - type: string
          example:
            - example-value
      required:
        - id
        - last_successful_run_date
        - links
        - steps
        - title
        - type
        - updated_at
    ExpandedZapStep:
      type: object
      description: An ordered list of steps that define the logic of the Zap.
      properties:
        action:
          description: Action
          oneOf:
            - $ref: '#/components/schemas/Action'
            - type: string
          example: example-value
        authentication:
          description: Authentication
          oneOf:
            - $ref: '#/components/schemas/Authentication'
            - type:
                - string
                - 'null'
          example: example-value
        inputs:
          readOnly: true
          description: The inputs for this specific Zap's step
          example: example-value
        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.
          example: Example Name
      required:
        - action
        - authentication
        - inputs
        - title
    ExpandedZapsResponse:
      type: object
      description: A page of returned Zaps.
      properties:
        links:
          type: object
          additionalProperties:
            type: string
            nullable: true
          readOnly: true
          description: Links related to the response data
          example: {}
        meta:
          type: object
          additionalProperties: {}
          readOnly: true
          description: Metadata about the response
          example: {}
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExpandedZap'
          description: The (potentially) expanded data for Zaps that matched the request
          example:
            - {}
      required:
        - data
        - links
        - meta
    Fieldset:
      type: object
      description: Represents a Fieldset
      properties:
        type:
          type: string
          readOnly: true
          description: The type of this Fieldset
          example: standard
        id:
          type: string
          description: The unique identifier for this Fieldset
          example: '500123'
        fields:
          allOf:
            - $ref: '#/components/schemas/FieldsetFieldsField'
          description: The fields this Fieldset consists of
          example: example-value
        title:
          type: string
          description: The title of this Fieldset
          example: Example Name
      required:
        - fields
        - id
        - title
        - type
    FieldsetFieldsField:
      anyOf:
        - $ref: '#/components/schemas/InputField'
        - $ref: '#/components/schemas/InfoField'
      description: Somewhat confusingly named, a field that is a list of either input fields or info fields.
    FormatEnum:
      enum:
        - DATETIME
        - MULTILINE
        - PASSWORD
        - CODE
        - READONLY
        - FILE
        - SELECT
      type: string
      description: |-
        * `DATETIME` - DATETIME
        * `MULTILINE` - MULTILINE
        * `PASSWORD` - PASSWORD
        * `CODE` - CODE
        * `READONLY` - READONLY
        * `FILE` - FILE
        * `SELECT` - SELECT
    InfoField:
      type: object
      description: Represents an Info-type Fieldset
      properties:
        type:
          type: string
          readOnly: true
          description: The type of this Info Field
          example: standard
        id:
          type: string
          description: The identifier of this Info Field
          example: '500123'
        description:
          type: string
          description: The description for this Info Field
          example: Example description for this resource.
      required:
        - description
        - id
        - type
    InputField:
      type: object
      description: Represents Input Field data as accepted by the API
      properties:
        type:
          type: string
          readOnly: true
          description: The type of Input Field
          example: standard
        id:
          type: string
          description: The identifier for this Input Field
          example: '500123'
        default_value:
          type: string
          description: The default value for this Input Field if not otherwise specified
          example: example-value
        depends_on:
          type: array
          items:
            type: string
          description: A list of dependencies for this Input Field
          example:
            - example-value
        description:
          type: string
          description: The description of this Input Field
          example: Example description for this resource.
        format:
          allOf:
            - $ref: '#/components/schemas/FormatEnum'
          description: |-
            The format of this Input Field from one of options provided

            * `DATETIME` - DATETIME
            * `MULTILINE` - MULTILINE
            * `PASSWORD` - PASSWORD
            * `CODE` - CODE
            * `READONLY` - READONLY
            * `FILE` - FILE
            * `SELECT` - SELECT
          example: example-value
        invalidates_input_fields:
          type: boolean
          description: Whether this Input Field invalidates
          example: true
        is_required:
          type: boolean
          description: Whether this Input Field is required
          example: true
        items:
          type: object
          additionalProperties:
            type: string
          description: A freeform object of items for this Input Field
          example: {}
        placeholder:
          type: string
          description: The placeholder for this Input Field when shown
          example: example-value
        title:
          type: string
          description: The title of this Input Field
          example: Example Name
        value_type:
          allOf:
            - $ref: '#/components/schemas/ValueTypeEnum'
          description: |-
            The type of the *value* of this Input Field

            * `STRING` - STRING
            * `NUMBER` - NUMBER
            * `INTEGER` - INTEGER
            * `BOOLEAN` - BOOLEAN
            * `ARRAY` - ARRAY
            * `OBJECT` - OBJECT
          example: standard
      required:
        - default_value
        - depends_on
        - description
        - format
        - id
        - invalidates_input_fields
        - is_required
        - items
        - placeholder
        - title
        - type
        - value_type
    InputFieldsResponse:
      type: object
      description: A successful response for getting the input fields for a particular Action.
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: The links object returned in paginated response bodies.
          example: example-value
        meta:
          allOf:
            - $ref: '#/components/schemas/BaseMeta'
          description: The meta object returned in paginated response bodies.
          example: example-value
        data:
          $ref: '#/components/schemas/RootFieldset'
      required:
        - data
        - links
        - meta
    InvalidZapGuesserResponse:
      type: object
      properties:
        messages:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: Contains informational messages about the prompt.
          example:
            - {}
    Links:
      type: object
      description: The links object returned in paginated response bodies.
      properties:
        next:
          type:
            - string
            - 'null'
          description: The URL of the next page of paginated results.
          example: example-value
        prev:
          type:
            - string
            - 'null'
          description: The URL of the previous page of paginated results.
          example: example-value
    ListInputFieldsRequest:
      type: object
      description: Common inputs with inputs and an authentication id.
      properties:
        data:
          $ref: '#/components/schemas/_ListInputFieldsRequest'
      required:
        - data
    ListOutputFieldsRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/_ListOutputFieldsRequest'
      required:
        - data
    Meta:
      type: object
      description: Metadata about a certain response
      properties:
        page:
          type: integer
          description: The current page
          example: 100
      required:
        - page
    OutputField:
      type: object
      properties:
        type:
          type: string
          readOnly: true
          description: The type of this specific Output Field
          example: standard
        id:
          type: string
          description: The identifier for this specific Output Field
          example: '500123'
        title:
          type: string
          description: The title of this specific Output Field
          example: Example Name
        sample:
          type: string
          description: An (optional) sample of what an Output Field's value may look like
          example: example-value
      required:
        - id
        - title
        - type
    OutputFieldsResponse:
      type: object
      description: A successful response containing Output Field data
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: The links object returned in paginated response bodies.
          example: example-value
        meta:
          allOf:
            - $ref: '#/components/schemas/BaseMeta'
          description: The meta object returned in paginated response bodies.
          example: example-value
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutputField'
          description: A list of the Output Fields matching the given request
          example:
            - {}
      required:
        - data
        - links
        - meta
    Profile:
      type: object
      description: An authenticated user profile.
      properties:
        id:
          type: integer
          description: The numeric identifier of this user
          example: 100
        first_name:
          type: string
          description: The first name of this user
          example: Example Name
        last_name:
          type: string
          description: The last name of this user
          example: Example Name
        full_name:
          type: string
          description: The combined full name of this user
          example: Example Name
        email:
          type: string
          format: email
          description: The email this user's account is associated with
          example: user@example.com
        email_confirmed:
          type: boolean
          description: Whether said email is confirmed yet or not
          example: true
        timezone:
          type: string
          description: The timezone set for this user
          example: example-value
      required:
        - email
        - email_confirmed
        - first_name
        - full_name
        - id
        - last_name
        - timezone
    RootFieldset:
      type: array
      items:
        anyOf:
          - $ref: '#/components/schemas/InputField'
          - $ref: '#/components/schemas/InfoField'
          - $ref: '#/components/schemas/Fieldset'
      description: The base concept of a Fieldset, from which others extend
    RunActionRequest:
      type: object
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/_RunActionRequest'
          description: Data for the Action Run
          example: example-value
      required:
        - data
    RunActionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/_RunActionResponse'
      required:
        - data
    RunTypeEnum:
      enum:
        - run
      type: string
      description: '* `run` - Run'
    TypeOfEnum:
      enum:
        - read
        - write
        - filter
        - search
        - search_or_write
      type: string
      description: |-
        * `read` - read
        * `write` - write
        * `filter` - filter
        * `search` - search
        * `search_or_write` - search_or_write
    ValueTypeEnum:
      enum:
        - STRING
        - NUMBER
        - INTEGER
        - BOOLEAN
        - ARRAY
        - OBJECT
      type: string
      description: |-
        * `STRING` - STRING
        * `NUMBER` - NUMBER
        * `INTEGER` - INTEGER
        * `BOOLEAN` - BOOLEAN
        * `ARRAY` - ARRAY
        * `OBJECT` - OBJECT
    WhitelabelApp:
      type: object
      description: An app available for whitelabel connection.
      properties:
        type:
          type: string
          readOnly: true
          default: app
          description: The resource type.
          example: app
        id:
          type: string
          readOnly: true
          description: The app's unique identifier.
          example: '500123'
        title:
          type: string
          description: The app's display name.
          example: Example Name
        image:
          type: string
          format: uri
          description: URL of the app's icon.
          example: https://example.com/path/abc123
        is_oauth:
          type: boolean
          readOnly: true
          description: Whether the app uses OAuth for authentication.
          example: true
        has_fields:
          type: boolean
          readOnly: true
          description: Whether the app has input fields a user must fill in when connecting.
          example: true
        has_byoc:
          type: boolean
          readOnly: true
          description: Whether the app requires the user to supply their own OAuth client credentials (client ID and/or client secret) when connecting. This is a best-effort heuristic based on the 
            app's auth field names and labels.
          example: true
        links:
          allOf:
            - $ref: '#/components/schemas/WhitelabelAppLinks'
          readOnly: true
          description: Related URLs for this app.
          example: example-value
      required:
        - has_byoc
        - has_fields
        - id
        - image
        - is_oauth
        - links
        - title
        - type
    WhitelabelAppLinks:
      type: object
      properties:
        mcp_authorize_url:
          type: string
          format: uri
          description: URL to authorize the user for MCP. Requires a session token to be set in the query parameters. Returns an OAuth exchange code.
          example: https://example.com/path/abc123
        mcp_server_url:
          type: string
          format: uri
          description: URL of the MCP server for this app. Requires an access token bound to a connection.
          example: https://example.com/path/abc123
      required:
        - mcp_authorize_url
        - mcp_server_url
    WhitelabelAppsResponse:
      type: object
      description: A JSON:API-style response of apps available for whitelabel connection.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WhitelabelApp'
          description: The list of apps.
          example: *id002
        links:
          type: object
          additionalProperties: {}
          readOnly: true
          description: Pagination links.
          example: *id003
        meta:
          type: object
          additionalProperties: {}
          readOnly: true
          description: Pagination metadata.
          example: *id004
      required:
        - data
        - links
        - meta
    Zap:
      type: object
      description: User Zaps.
      properties:
        id:
          type: integer
          description: The numeric identifier of this Zap
          example: 100
        title:
          type: string
          description: The title of this Zap
          example: Example Name
        state:
          type: string
          description: The current state of this Zap
          example: active
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ZapStep'
          readOnly: true
          description: The steps this Zap consists of
          example:
            - {}
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL to this Zap
          example: https://example.com/path/abc123
        modified_at:
          type: string
          description: The last time this Zap was modified
          example: example-value
      required:
        - id
        - modified_at
        - state
        - steps
        - title
        - url
    ZapGuesserRawStep:
      type: object
      properties:
        title:
          type:
            - string
            - 'null'
          description: The title of this step
          example: Example Name
        app:
          type: string
          description: This step's human-readable name
          example: example-value
        api:
          type: string
          description: The Zapier API integration this step uses
          example: example-value
      required:
        - api
        - app
        - title
    ZapGuesserRequest:
      type: object
      properties:
        description:
          type: string
          description: The description of the Zap you wish to create
          example: Example description for this resource.
      required:
        - description
    ZapGuesserResponse:
      type: object
      properties:
        title:
          type: string
          description: The generated title for this suggested Zap.
          example: Example Name
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ZapGuesserStep'
          description: The steps this suggested Zap consists of.
          example:
            - {}
        prefilled_url:
          type: string
          readOnly: true
          description: A generated prefilled URL to take you to the Zapier editor (selects the highest confidence steps).
          example: https://example.com/path/abc123
        messages:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: Contains informational messages about the prompt.
          example:
            - {}
      required:
        - prefilled_url
        - steps
        - title
    ZapGuesserStep:
      type: object
      properties:
        step:
          allOf:
            - $ref: '#/components/schemas/ZapGuesserRawStep'
          readOnly: true
          description: The highest scoring (most relevant) step for this Zap
          example: example-value
        alternatives:
          type: array
          items:
            $ref: '#/components/schemas/ZapGuesserRawStep'
          readOnly: true
          description: Alternative steps that we are less confident are relevant, but may have been intended
          example:
            - {}
      required:
        - alternatives
        - step
    ZapRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateZapRequest'
      required:
        - data
    ZapRun:
      type: object
      description: A single Zap Run response.
      properties:
        id:
          type: string
          format: uuid
          description: Zap Run ID
          example: 550e8400-e29b-41d4-a716-446655440000
        zap_id:
          type: integer
          description: Associated Zap ID
          example: 100
        start_time:
          type:
            - string
            - 'null'
          format: date-time
          description: Datetime when the Zap Run started
          example: '2026-05-01T12:00:00Z'
        end_time:
          type:
            - string
            - 'null'
          format: date-time
          description: Datetime when the Zap Run ended
          example: '2026-05-01T12:00:00Z'
        status:
          type: string
          description: Execution status of the Zap Run
          example: active
        zap_title:
          type:
            - string
            - 'null'
          description: The title of the Zap at the time it ran
          example: example-value
        steps:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ZapRunStep'
          description: Contains the execution details of each step
          example:
            - {}
        data_in:
          oneOf:
            - {}
            - type: 'null'
          description: The input data for the Zap Run
          example: example-value
        data_out:
          oneOf:
            - {}
            - type: 'null'
          description: The output data for the Zap Run
          example: example-value
      required:
        - id
        - status
        - steps
        - zap_id
        - zap_title
    ZapRunStep:
      type: object
      description: A single step in a Zap Run.
      properties:
        status:
          type:
            - string
            - 'null'
          description: Execution status of the step
          example: active
        start_time:
          type:
            - string
            - 'null'
          format: date-time
          description: Datetime when the step was executed
          example: '2026-05-01T12:00:00Z'
      required:
        - status
    ZapRunsResponse:
      type: object
      description: A list of Zap Runs.
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Links'
          description: The links object returned in paginated response bodies.
          example: example-value
        meta:
          allOf:
            - $ref: '#/components/schemas/BaseMeta'
          description: The meta object returned in paginated response bodies.
          example: example-value
        data:
          type: array
          items:
            $ref: '#/components/schemas/ZapRun'
          description: The returned data after a successful Zap run
          example:
            - {}
      required:
        - links
        - meta
    ZapStep:
      type: object
      description: One step in a Zap
      properties:
        type_of:
          allOf:
            - $ref: '#/components/schemas/TypeOfEnum'
          description: |-
            The type of this Step

            * `read` - read
            * `write` - write
            * `filter` - filter
            * `search` - search
            * `search_or_write` - search_or_write
          example: standard
        app:
          allOf:
            - $ref: '#/components/schemas/ZapStepApp'
          description: The App used in this Step
          example: example-value
        params:
          type:
            - object
            - 'null'
          additionalProperties: {}
          readOnly: true
          description: The parameters used by this Step
          example: {}
      required:
        - app
        - params
        - type_of
    ZapStepApp:
      type: object
      description: Data for the App used in a given Zap's step
      properties:
        id:
          type: integer
          description: The numerical identifier of this Zap step's App
          example: 100
        uuid:
          type: string
          description: UUID identifier for this Zap step's App
          example: 550e8400-e29b-41d4-a716-446655440000
        title:
          type: string
          description: The name of this App
          example: Example Name
        slug:
          type: string
          description: The shortened slug for this App
          example: example-value
        description:
          type: string
          description: The description of this App
          example: Example description for this resource.
        hex_color:
          type: string
          description: The primary (hex) color for this App
          example: example-value
        image:
          type: string
          description: The image for this App
          example: example-value
        images:
          allOf:
            - $ref: '#/components/schemas/ZapTemplateStepImages'
          description: A set of images of various sizes for this App
          example: example-value
        api:
          type: string
          description: The name of the API this App references
          example: example-value
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL for this App
          example: https://example.com/path/abc123
      required:
        - api
        - description
        - hex_color
        - id
        - image
        - images
        - slug
        - title
        - url
        - uuid
    ZapTemplate:
      type: object
      description: A Zap Template.
      properties:
        id:
          type: integer
          description: The numeric identifier of this Zap Template
          example: 100
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ZapTemplateStep'
          readOnly: true
          description: The steps this Zap Template are composed of
          example:
            - {}
        title:
          type: string
          description: The title of this Zap Template
          example: Example Name
        slug:
          type: string
          description: The shortened slug for this Zap Template
          pattern: ^[-a-zA-Z0-9_]+$
          example: example-value
        status:
          allOf:
            - $ref: '#/components/schemas/ZapTemplateStatusEnum'
          description: |-
            The status of this Zap Template

            * `draft` - draft
            * `published` - published
          example: active
        description_plain:
          type: string
          readOnly: true
          description: The plain (rendered) description for this Zap Template
          example: example-value
        description_raw:
          type: string
          description: The raw description for this Zap Template. May include styling syntax intended to be rendered
          example: example-value
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL for this Zap Template
          example: https://example.com/path/abc123
        description:
          type: string
          description: The HTML description for this Zap Template. Intended to be rendered in a browser
          example: Example description for this resource.
        create_url:
          type: string
          format: uri
          readOnly: true
          description: The URL to access to create a Zap from this Zap Template
          example: https://example.com/path/abc123
        type:
          type: string
          readOnly: true
          default: guided_zap
          description: The type of this Zap Template
          example: guided_zap
      required:
        - create_url
        - description
        - description_plain
        - description_raw
        - id
        - slug
        - status
        - steps
        - title
        - type
        - url
    ZapTemplateStatusEnum:
      enum:
        - draft
        - published
      type: string
      description: |-
        * `draft` - draft
        * `published` - published
    ZapTemplateStep:
      type: object
      description: One step in a Zap Template.
      properties:
        id:
          type:
            - integer
            - 'null'
          readOnly: true
          description: The numeric identifier of this step, if specified
          example: 100
        uuid:
          type: string
          format: uuid
          description: UUID identifier of this step
          example: 550e8400-e29b-41d4-a716-446655440000
        title:
          type: string
          description: The name of this step
          example: Example Name
        slug:
          type: string
          description: The shortened slug for this step
          pattern: ^[-a-zA-Z0-9_]+$
          example: example-value
        description:
          type: string
          description: The description of this step
          example: Example description for this resource.
        image:
          type: string
          description: The image URL for this step
          example: example-value
        hex_color:
          type: string
          description: The primary (hex) color for this step
          example: example-value
        images:
          allOf:
            - $ref: '#/components/schemas/ZapTemplateStepImages'
          description: The images (at various sizes) for this step
          example: example-value
        api:
          type: string
          readOnly: true
          description: The API used in this step
          example: example-value
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL for this step
          example: https://example.com/path/abc123
        label:
          type:
            - string
            - 'null'
          readOnly: true
          description: The label for this step
          example: Example Name
      required:
        - api
        - description
        - hex_color
        - id
        - image
        - images
        - label
        - slug
        - title
        - url
        - uuid
    ZapTemplateStepImages:
      type: object
      description: Images for a Zap Template at various sizes
      properties:
        url_16x16:
          type: string
          description: URL to 16x16 image for Zap Template
          example: example-value
        url_32x32:
          type: string
          description: URL to 32x32 image for Zap Template
          example: example-value
        url_64x64:
          type: string
          description: URL to 64x64 image for Zap Template
          example: example-value
        url_128x128:
          type: string
          description: URL to 128x128 image for Zap Template
          example: example-value
      required:
        - url_128x128
        - url_16x16
        - url_32x32
        - url_64x64
    ZapsResponse:
      type: object
      description: A page of returned Zaps.
      properties:
        next:
          type:
            - string
            - 'null'
          format: uri
          readOnly: true
          description: The URL to get the next set of records
          example: https://example.com/path/abc123
        previous:
          type:
            - string
            - 'null'
          format: uri
          readOnly: true
          description: The URL to get the previous set of records
          example: https://example.com/path/abc123
        count:
          type: integer
          readOnly: true
          description: The total number of records matching the request
          example: 100
        objects:
          type: array
          items:
            $ref: '#/components/schemas/Zap'
          description: The returned Zap data
          example:
            - {}
      required:
        - count
        - next
        - objects
        - previous
    _ActionRunResponse:
      type: object
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/RunTypeEnum'
          description: |-
            The type of this object

            * `run` - Run
          example: standard
        status:
          $ref: '#/components/schemas/_ActionRunResponseStatusEnum'
        results:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: Could be empty, even if the action was successfully run.
          example:
            - {}
        errors:
          type: array
          items:
            $ref: '#/components/schemas/_ActionRunResponseError'
          description: Any errors returned by the partner when running this action.
          example:
            - {}
      required:
        - errors
        - status
        - type
    _ActionRunResponseError:
      type: object
      description: The error information returned from a third party when running an action.
      properties:
        code:
          allOf:
            - $ref: '#/components/schemas/CodeEnum'
          description: |-
            Error type of the result object.

            * `user` - user
            * `authentication` - authentication
            * `partner` - partner
            * `system` - system
            * `throttled` - throttled
            * `system_throttled` - system_throttled
            * `hydration` - hydration
          example: example-value
        title:
          type: string
          description: A short summary of the problem.
          example: Example Name
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          example: example-value
        delay:
          type: integer
          description: When a partner throttled the execution call (error_type = throttled), this value will hold the number of seconds to wait before retrying.
          example: 100
        meta:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: Any additional error information returned from the partner.
          example: {}
    _ActionRunResponseStatusEnum:
      enum:
        - success
        - error
        - waiting
      type: string
      description: |-
        * `success` - success
        * `error` - error
        * `waiting` - waiting
    _ActionTestRequest:
      type: object
      description: The request structure to test a particular Action
      properties:
        limit:
          type:
            - integer
            - 'null'
          minimum: 1
          default: 10
          description: Used for paginating results. Specifies the maximum number of items to return per page.
          example: 10
        offset:
          type:
            - integer
            - 'null'
          minimum: 0
          default: 0
          description: Used for paginating results. Specifies the offset to use. Defaults to 0
          example: 0
        authentication:
          type:
            - string
            - 'null'
          description: Authentication, if required, to be able to run the given Action
          example: example-value
        inputs:
          type: object
          additionalProperties: {}
          description: Inputs to be provided to the given 'read' Action's test run
          example: {}
      required:
        - authentication
        - inputs
    _AuthenticationCreateRequest:
      type: object
      description: The object used to create a new Authentication
      properties:
        title:
          type: string
          description: The title of the authentication.
          maxLength: 255
          example: Example Name
        app:
          type: string
          format: uuid
          description: A canonical App ID, as provided by the `/apps` endpoint.
          example: 550e8400-e29b-41d4-a716-446655440000
        authentication_fields:
          type: object
          additionalProperties: {}
          description: Required values to create an authentication. These values will be used by the target integration to successfully create the Authentication. See our Adding an Authentication 
            guide for more information.
          example: {}
      required:
        - app
        - authentication_fields
        - title
    _ListInputFieldsRequest:
      type: object
      description: The common data object that includes inputs and an authentication id.
      properties:
        authentication:
          type:
            - string
            - 'null'
          description: An Authentication ID provided by the `/authentications` endpoint.
          example: example-value
        inputs:
          type: object
          additionalProperties: {}
          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.
          example: {}
      required:
        - authentication
        - inputs
    _ListOutputFieldsRequest:
      type: object
      description: The common data object that includes inputs and an authentication id.
      properties:
        authentication:
          type:
            - string
            - 'null'
          description: An Authentication ID, as provided by the `/authentications` endpoint.
          example: example-value
        inputs:
          type: object
          additionalProperties: {}
          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.
          example: {}
        fetch_live_samples:
          type: boolean
          default: false
          description: Whether to retrieve live samples for the field. While this can be helpful in supporting the identification of an output, note that this has latency implications as it may 
            require an additional request to 3rd party services. This is not supported for `WRITE` actions, please use step testing instead.
          example: false
      required:
        - authentication
        - inputs
    _RunActionRequest:
      type: object
      properties:
        action:
          type: string
          description: The ID for the Action to be run
          example: example-value
        authentication:
          type:
            - string
            - 'null'
          description: The ID for Authentication (if required)
          example: example-value
        inputs:
          type: object
          additionalProperties: {}
          description: Inputs to be provided to the Action referenced by the ID field, when run
          example: {}
      required:
        - action
        - authentication
        - inputs
    _RunActionResponse:
      type: object
      description: The response after an Action Run
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/RunTypeEnum'
          description: |-
            The type of this object

            * `run` - Run
          example: standard
        id:
          type: string
          format: uuid
          description: The UUID of this Action Run
          example: 550e8400-e29b-41d4-a716-446655440000
      required:
        - id
        - type
  securitySchemes:
    ClientIDAuthentication:
      type: apiKey
      in: query
      name: client_id
      description: See our authentication documentation for how to find your Client ID
      x-zapier-auth-scheme-exempt: true
    OAuth:
      type: oauth2
      description: 'See our OAuth2 authentication documentation here: https://docs.zapier.com/powered-by-zapier/api-reference/authentication'
      flows:
        authorizationCode:
          authorizationUrl: https://zapier.com/oauth/authorize/
          tokenUrl: https://zapier.com/oauth/token/
          refreshUrl: https://zapier.com/oauth/token/
          scopes:
            profile: Read profile information about the currently-authenticated user
            zap: Read Zaps
            zap:write: Write Zaps
            authentication: Read Authentications
            authentication:write: Write Authentications
            zap:runs: Read Zap Runs
            action:run: Run an Action
            zap:all: Read Zaps accessible to the account
        implicit:
          authorizationUrl: https://zapier.com/oauth/authorize/
          scopes:
            profile: Read profile information about the currently-authenticated user
            zap: Read Zaps
            zap:write: Write Zaps
            authentication: Read Authentications
            authentication:write: Write Authentications
            zap:runs: Read Zap Runs
            action:run: Run an Action
            zap:all: Read Zaps accessible to the account
servers:
  - url: https://api.zapier.com
tags:
  - name: Accounts
    description: Refers to resources interacting with 'Accounts' associated resources
  - name: Actions
    description: Refers to resources interacting with 'Actions' associated resources
  - name: Apps
    description: Refers to resources interacting with 'Apps' associated resources
  - name: Authentications
    description: Refers to resources interacting with 'Authentications' associated resources
  - name: Categories
    description: Refers to resources interacting with 'Categories' associated resources
  - name: Experimental
    description: Refers to resources interacting with 'Experimental' associated resources
  - name: Inputs
    description: Refers to resources interacting with 'Inputs' associated resources
  - name: Outputs
    description: Refers to resources interacting with 'Outputs' associated resources
  - name: Zaps
    description: Refers to resources interacting with 'Zaps' associated resources
  - name: Zap Templates
    description: Refers to resources interacting with 'Zap Templates' associated resources