> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapier.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Zaps [v1]

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

#### When using OAuth

This endpoint requires the `zap` OAuth scope.

This API is [rate limited](/powered-by-zapier/api-reference/rate-limiting).


## OpenAPI

````yaml https://api.zapier.com/schema get /v1/zaps
openapi: 3.1.0
info:
  title: Partner API
  version: 2024.11.0
  description: >

    ## 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
servers:
  - url: https://api.zapier.com
security: []
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
paths:
  /v1/zaps:
    get:
      tags:
        - Zaps
      summary: Get Zaps [v1]
      description: |-
        This endpoint returns a list of Zaps for the authenticated Zapier user.

        #### When using OAuth

        This endpoint requires the `zap` OAuth scope.
      operationId: v1_zaps_list
      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.'
        - 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.
        - 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
      responses:
        '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: null
                      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: null
                            - 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: null
                          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: null
                            - 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: null
                          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: ''
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: 401 Response
        '403':
          description: Invalid authentication
        '409':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          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: {}
          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: {}
          description: 503 Response
        '504':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: 504 Response
      security:
        - OAuth:
            - zap
components:
  schemas:
    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
        previous:
          type:
            - string
            - 'null'
          format: uri
          readOnly: true
          description: The URL to get the previous set of records
        count:
          type: integer
          readOnly: true
          description: The total number of records matching the request
        objects:
          type: array
          items:
            $ref: '#/components/schemas/Zap'
          description: The returned Zap data
      required:
        - count
        - next
        - objects
        - previous
    Zap:
      type: object
      description: User Zaps.
      properties:
        id:
          type: integer
          description: The numeric identifier of this Zap
        title:
          type: string
          description: The title of this Zap
        state:
          type: string
          description: The current state of this Zap
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ZapStep'
          readOnly: true
          description: The steps this Zap consists of
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL to this Zap
        modified_at:
          type: string
          description: The last time this Zap was modified
      required:
        - id
        - modified_at
        - state
        - steps
        - title
        - url
    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
        app:
          allOf:
            - $ref: '#/components/schemas/ZapStepApp'
          description: The App used in this Step
        params:
          type:
            - object
            - 'null'
          additionalProperties: {}
          readOnly: true
          description: The parameters used by this Step
      required:
        - app
        - params
        - type_of
    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
    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
        uuid:
          type: string
          description: UUID identifier for this Zap step's App
        title:
          type: string
          description: The name of this App
        slug:
          type: string
          description: The shortened slug for this App
        description:
          type: string
          description: The description of this App
        hex_color:
          type: string
          description: The primary (hex) color for this App
        image:
          type: string
          description: The image for this App
        images:
          allOf:
            - $ref: '#/components/schemas/ZapTemplateStepImages'
          description: A set of images of various sizes for this App
        api:
          type: string
          description: The name of the API this App references
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL for this App
      required:
        - api
        - description
        - hex_color
        - id
        - image
        - images
        - 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
        url_32x32:
          type: string
          description: URL to 32x32 image for Zap Template
        url_64x64:
          type: string
          description: URL to 64x64 image for Zap Template
        url_128x128:
          type: string
          description: URL to 128x128 image for Zap Template
      required:
        - url_128x128
        - url_16x16
        - url_32x32
        - url_64x64
  securitySchemes:
    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
            connection:read: Read Connections (Authentications)
            connection:write: Write Connections (Authentications)
        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
            connection:read: Read Connections (Authentications)
            connection:write: Write Connections (Authentications)

````