openapi: 3.0.3
info:
  title: Wufoo REST Comments Entries API
  description: 'The Wufoo REST API v3 provides programmatic read and write access to a Wufoo

    account: Forms, Fields, Entries, Reports, Widgets, Comments, Users, and

    Webhooks. Every request is per-subdomain and authenticates with the account

    API key over HTTP Basic Auth. Endpoints support `.json` or `.xml` response

    formats by appending the extension to the URL.

    '
  version: '3.0'
  contact:
    name: Wufoo Support
    url: https://help.surveymonkey.com/wufoo/
  license:
    name: Wufoo Terms of Use
    url: https://www.wufoo.com/terms-of-use/
servers:
- url: https://{subdomain}.wufoo.com/api/v3
  description: Wufoo account subdomain
  variables:
    subdomain:
      default: account
      description: Your Wufoo account subdomain.
security:
- basicAuth: []
tags:
- name: Entries
  description: Read and create form submissions.
paths:
  /forms/{identifier}/entries.{format}:
    get:
      tags:
      - Entries
      summary: List Form Entries
      description: Returns entries (submissions) for a form, with filtering and paging.
      operationId: listFormEntries
      parameters:
      - $ref: '#/components/parameters/Identifier'
      - $ref: '#/components/parameters/Format'
      - name: system
        in: query
        schema:
          type: boolean
      - name: pretty
        in: query
        schema:
          type: boolean
      - name: pageStart
        in: query
        schema:
          type: integer
          default: 0
      - name: pageSize
        in: query
        schema:
          type: integer
          default: 25
          maximum: 100
      - name: sort
        in: query
        description: Field ID to sort by.
        schema:
          type: string
      - name: sortDirection
        in: query
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: match
        in: query
        description: AND or OR when combining multiple Filter parameters.
        schema:
          type: string
          enum:
          - AND
          - OR
      responses:
        '200':
          description: Entries list.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Entries:
                    type: array
                    items:
                      $ref: '#/components/schemas/Entry'
    post:
      tags:
      - Entries
      summary: Submit Form Entry
      description: Submits a new entry to the form. Body is form-encoded `Field{N}=value` pairs.
      operationId: submitFormEntry
      parameters:
      - $ref: '#/components/parameters/Identifier'
      - $ref: '#/components/parameters/Format'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties:
                type: string
              example:
                Field1: Jane
                Field2: Doe
                Field3: jane@example.com
      responses:
        '200':
          description: Submission result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResult'
        '429':
          description: Slow Down — submission rate limit exceeded (50 per user per 5 minute sliding window).
  /forms/{identifier}/entries/count.{format}:
    get:
      tags:
      - Entries
      summary: Count Form Entries
      description: Returns the number of entries for a form.
      operationId: countFormEntries
      parameters:
      - $ref: '#/components/parameters/Identifier'
      - $ref: '#/components/parameters/Format'
      - name: pretty
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Entry count for the form.
          content:
            application/json:
              schema:
                type: object
                properties:
                  EntryCount:
                    type: string
  /reports/{identifier}/entries.{format}:
    get:
      tags:
      - Entries
      summary: List Report Entries
      description: Returns entries filtered by report criteria.
      operationId: listReportEntries
      parameters:
      - $ref: '#/components/parameters/Identifier'
      - $ref: '#/components/parameters/Format'
      - name: system
        in: query
        schema:
          type: boolean
      - name: pretty
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Entry list for the report.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Entries:
                    type: array
                    items:
                      $ref: '#/components/schemas/Entry'
  /reports/{identifier}/entries/count.{format}:
    get:
      tags:
      - Entries
      summary: Count Report Entries
      description: Returns the number of entries in the report.
      operationId: countReportEntries
      parameters:
      - $ref: '#/components/parameters/Identifier'
      - $ref: '#/components/parameters/Format'
      - name: pretty
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Report entry count.
          content:
            application/json:
              schema:
                type: object
                properties:
                  EntryCount:
                    type: string
components:
  parameters:
    Format:
      name: format
      in: path
      required: true
      description: Response serialization format.
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
    Identifier:
      name: identifier
      in: path
      required: true
      description: Form or report hash (preferred) or its title.
      schema:
        type: string
  schemas:
    SubmitResult:
      type: object
      properties:
        Success:
          type: integer
          enum:
          - 0
          - 1
        EntryId:
          type: integer
        EntryLink:
          type: string
          format: uri
        RedirectUrl:
          type: string
          format: uri
        ErrorText:
          type: string
        FieldErrors:
          type: array
          items:
            type: object
            properties:
              ID:
                type: string
              ErrorText:
                type: string
    Entry:
      type: object
      description: Submission keyed by `Field{ID}` plus audit fields.
      additionalProperties: true
      properties:
        EntryId:
          type: string
        DateCreated:
          type: string
          format: date-time
        CreatedBy:
          type: string
        DateUpdated:
          type: string
          format: date-time
        UpdatedBy:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic Auth. Use your Wufoo API key as the username and any non-empty

        string as the password. Servers require TLS v1.0 or higher; SSLv3 and lower

        are blocked.

        '