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

# Webform List

> Use this API to return an array of all of your webforms. You can filter, search and sort webforms.



## OpenAPI

````yaml /openapi-v1.json post /webform/search
openapi: 3.1.0
info:
  title: Mailercloud Marketing API
  version: 1.0.0
  description: >-
    Campaigns, contacts, lists, segments, automations, and webhooks for the
    Mailercloud Marketing Platform.
servers:
  - url: https://cloudapi.mailercloud.com/v1
security:
  - apiKey: []
tags:
  - name: Campaigns
  - name: Contacts
  - name: Lists
  - name: Tags
  - name: Segments
  - name: Custom Properties
  - name: Senders
  - name: Templates
  - name: Automations
  - name: Webhooks
  - name: Webforms
  - name: Inbox Tracker
  - name: Account
paths:
  /webform/search:
    post:
      tags:
        - Webforms
      summary: Webform List
      description: >-
        Use this API to return an array of all of your webforms. You can filter,
        search and sort webforms.
      operationId: webform-list
      parameters:
        - name: Content-Type
          in: header
          required: false
          description: application/json
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              x-examples:
                example-1:
                  limit: 0
                  page: 0
                  search: string
                  sort_field: string
                  sort_order: string
                  date_from: string
                  date_to: string
                  status: string
              properties:
                limit:
                  type: number
                  description: |-
                    Maximum number of elements to return.

                    Maximum: 100 Minimum: 10
                page:
                  type: number
                  description: >-
                    You can retrieve a subset of records starting from the page
                    value you have specified. You can add a limit, which will
                    determine the number of records you can retrieve on a single
                    page.


                    Starts From: 1
                search:
                  type: string
                  minLength: 1
                  description: Filter form by name , giving name in search keyword
                sort_field:
                  type: string
                  minLength: 1
                  description: >-
                    Sort list data based on this field


                    Available sort fields - name, modifiedDate, view_count,
                    submission_count, new_contact_count
                sort_order:
                  type: string
                  minLength: 1
                  description: |-
                    If sort_field is given then sort_order is required

                    Sorting order for sort field

                    Available sort orders - asc, ASC, desc, DESC
                date_from:
                  type: string
                  minLength: 1
                  description: Filter forms based on modified date.
                date_to:
                  type: string
                  minLength: 1
                  description: Filter forms based on modified date.
                status:
                  type: string
                  minLength: 1
                  description: >-
                    Filter forms based on status. Set status to Active to get
                    forms with embed code.


                    Available status – Active, Inactive, Draft, Duplicate
              required:
                - limit
                - page
            examples:
              example-1:
                value:
                  limit: 0
                  page: 0
                  search: string
                  sort_field: string
                  sort_order: string
                  date_from: string
                  date_to: string
                  status: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                description: ''
                type: object
                x-examples:
                  example-1:
                    count: 1
                    data:
                      - embed_code: >-
                          <script charset="utf-8" type="text/javascript"
                          src="https://js.mailercloud.com/form/form.js"><\/script>

                          <script>

                          (function() {
                            mcform.create({
                              formId: "RUV1QDI1NjBAMDAwMDAwMA==",
                              targetElement: "form_element_id"
                            })
                          })();

                          <\/script>
                        id: RUV1QDI1NjBAMDAwMDAwMA==
                        last_updated: '2021-08-25 20:48:29'
                        linked_list: weee List-25 Aug 2021 08.48 PM
                        name: weee
                        new_contact_count: 1
                        status: Active
                        submission_count: 2
                        type: Embedded form
                        view_count: 6
                properties:
                  count:
                    type: number
                  data:
                    type: array
                    uniqueItems: true
                    minItems: 1
                    items:
                      type: object
                      properties:
                        embed_code:
                          type: string
                          minLength: 1
                        id:
                          type: string
                          minLength: 1
                          description: Unique identifier of the webform.
                        last_updated:
                          type: string
                          minLength: 1
                        linked_list:
                          type: string
                          minLength: 1
                        name:
                          type: string
                          minLength: 1
                        new_contact_count:
                          type: number
                          description: >-
                            Number of NEW contacts created through the form -
                            submissions from addresses that were not already in
                            your audience. Lifetime total for the form, summed
                            across all of its versions (republishing a form
                            starts a new version and its counters keep
                            accumulating here).
                        status:
                          type: string
                          minLength: 1
                        submission_count:
                          type: number
                          description: >-
                            Number of submissions the form has received.
                            Lifetime total for the form, summed across all of
                            its versions (republishing a form starts a new
                            version and its counters keep accumulating here).
                        type:
                          type: string
                          minLength: 1
                        view_count:
                          type: number
                          description: >-
                            Number of times the form has been viewed. Lifetime
                            total for the form, summed across all of its
                            versions (republishing a form starts a new version
                            and its counters keep accumulating here).
              examples:
                example-1:
                  value:
                    value:
                      count: 0
                      data:
                        - embed_code: string
                          id: string
                          last_updated: string
                          linked_list: string
                          name: string
                          new_contact_count: 0
                          status: string
                          submission_count: 0
                          type: string
                          view_count: 0
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Your Mailercloud API key (plain text, no Bearer prefix). Create keys in
        Settings → API.

````