openapi: 3.2.0
info:
  title: ClickFunnels Forms::Submission API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Forms::Submission
  description: '> Allows to submit and analyze forms programmatically


    The `Forms::Submission` resource together with the `Form` and other `Forms::` allows you to create

    form submission programmatically outside of ClickFunnels.


    To get the raw submission data, refer to the `FormSubmission` resource.

    '
paths:
  /forms/{form_id}/submissions:
    get:
      tags:
      - Forms::Submission
      summary: List Submissions
      description: List submissions for a form
      operationId: listFormsSubmissions
      parameters:
      - name: form_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FormsSubmissionAttributes'
              example:
              - id: 70
                public_id: SVWQCq
                form_id: 190
                contact_id: 67
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 72
                public_id: OpMkZx
                form_id: 194
                contact_id: 68
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
    post:
      tags:
      - Forms::Submission
      summary: Create Submission
      description: Add a new submission to a form
      operationId: createFormsSubmissions
      parameters:
      - name: form_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Submission
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                forms_submission:
                  type: object
                  $ref: '#/components/schemas/FormsSubmissionParameters'
            example:
              forms_submission:
                contact_id: 5
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormsSubmissionAttributes'
              example:
                id: 76
                public_id: XJBeoW
                form_id: 202
                contact_id: 70
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
  /forms/submissions/{id}:
    get:
      tags:
      - Forms::Submission
      summary: Fetch Submission
      description: Retrieve a submission for a form
      operationId: getFormsSubmissions
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormsSubmissionAttributes'
              example:
                id: 74
                public_id: vXreot
                form_id: 198
                contact_id: 69
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    put:
      tags:
      - Forms::Submission
      summary: Update Submission
      description: Update a submission for a form
      operationId: updateFormsSubmissions
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Submission
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                forms_submission:
                  type: object
                  $ref: '#/components/schemas/FormsSubmissionParametersUpdate'
            example:
              forms_submission:
                contact_id: 5
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormsSubmissionAttributes'
              example:
                id: 80
                public_id: uHDBPL
                form_id: 210
                contact_id: 72
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    delete:
      tags:
      - Forms::Submission
      summary: Remove Submission
      description: Delete a submission for a form
      operationId: removeFormsSubmissions
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
components:
  schemas:
    FormsSubmissionParametersUpdate:
      type: object
      title: Submissions
      description: Submissions
      required: []
      properties:
        contact_id:
          type:
          - integer
          - 'null'
          description: Contact
      example:
        forms_submission:
          contact_id: 5
    FormsSubmissionParameters:
      type: object
      title: Submissions
      description: Submissions
      required: []
      properties:
        contact_id:
          type:
          - integer
          - 'null'
          description: Contact
      example:
        forms_submission:
          contact_id: 5
    FormsSubmissionAttributes:
      type: object
      title: Submissions
      description: Submissions
      properties:
        id:
          type: integer
          description: Submission ID
        public_id:
          type:
          - string
          - 'null'
          description: Submission public ID
        form_id:
          type: integer
          description: Form ID
        contact_id:
          type:
          - integer
          - 'null'
          description: Contact
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Added
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated
      example:
        id: 6
        public_id: tWxHeY
        form_id: 15
        contact_id: 5
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
      required:
      - contact_id
      - created_at
      - form_id
      - id
      - public_id
      - updated_at
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      name: sort_property
      in: query
      description: 'Sort property of a list response. The default is id and thus the created_at order.

        If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

        '
      required: false
      schema:
        type: string
        enum:
        - id
        - updated_at
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  headers:
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com