MYmyclickfunnels
FormSubmission

List Form Submissions

Changed on

List form submissions. This is a list of all form submissions for the workspace, including the submitted standard and custom fields. Please refer to the Form and Forms::Submission resources if you would like to submit forms programmatically.

get/workspaces/{workspace_id}/form_submissions

Request

Path parameters

workspace_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

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.

idstring

A comma-separated list of form submission IDs to filter by.

page_idstring

A comma-separated list of page IDs to filter by.

contact_idstring

A comma-separated list of contact IDs to filter by.

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

{
  "id": "1,2,3",
  "page_id": "32432,5544",
  "contact_id": "1,42"
}

Response

OK

idinteger

The unique identifier for the form submission

public_idstring nullable

The unique public identifier for the form submission

contact_idinteger nullable

The unique identifier of the contact who submitted the form

workspace_idinteger

The unique identifier of the workspace that the form was part of

page_idinteger nullable

The unique identifier of the page that the form was on

created_atstring nullable

The date and time the form was submitted

updated_atstring nullable

The date and time the form submission was last updated

dataobject

The dynamic form field data submitted by the user. The HTML form input field names build the keys of this object, and the user's HTML inputs are the values.

Example response

[
  {
    "id": 1,
    "public_id": "LkmpVe",
    "contact_id": 7,
    "workspace_id": 42000,
    "page_id": 1,
    "created_at": null,
    "updated_at": null,
    "data": {
      "url": "/contact",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com"
    }
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status