Zoho Forms

App · 9 actions

Connect Zoho Forms to automate forms and submitted records.

Actions

ActionWhat it does
Add a recordSubmits a new record to a form, using a set of field values keyed by each field's API name.
Get a recordGets one record of a form by its form ID and record ID, with all of its submitted field values.
Get form detailsGets one form by its form ID, including its fields and their API names, which you need to add, sort or search records.
List formsLists the forms in your Zoho Forms account, one page at a time, optionally searched by name, filtered by status and sorted.
List recordsLists the submitted records (responses) of a form, one page at a time, optionally sorted by a field.
List report recordsLists the records shown in one of a form's reports, by form ID and report ID, one page at a time and optionally sorted by a field.
List reportsLists the reports set up on a form, one page at a time, optionally searched by name and sorted.
Search recordsSearches a form's records for those matching the conditions you give, with optional fields to return, sorting and paging.
Search report recordsSearches the records in one of a form's reports for those matching the conditions you give, with optional fields to return, sorting and paging.

Add a record

Submits a new record to a form, using a set of field values keyed by each field's API name. Returns the new record's ID.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.
DatadataobjectRequired
A JSON object with the field values to submit. Each key is the API name of a field from Get form details, and each value must use the format of that field type; see Values by field type below.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get a record

Gets one record of a form by its form ID and record ID, with all of its submitted field values.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.
Record idrecord_idtextRequired
The unique ID of the record you want to retrieve. Get it from Add a record, List records, List report records or Search report records.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get form details

Gets one form by its form ID, including its fields and their API names, which you need to add, sort or search records.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List forms

Lists the forms in your Zoho Forms account, one page at a time, optionally searched by name, filtered by status and sorted. Returns each form's ID, name and status.

Inputs

Pagepagenumber
To get the list of forms from the respective pages. The default value is 1.From 1 to 10000.
Limitlimitnumber
The number of forms to return per page. The maximum value is 100. The default value is 50.From 1 to 100.
Searchsearchtext
To search forms by name. Partial matches are supported.
Statusstatustext
Returns only the forms with this status: active (accepting responses) or disable (not accepting responses).One of: active, disable, deactive, deleted_user_form.
Sort bysort_bytext
The value to sort the forms by. display_name sorts by the form name. The default value is created_time.One of: created_time, modified_time, display_name.
Sort ordersort_ordertext
The order in which forms are sorted, based on the value of sort_by. The default value is desc.One of: asc, desc.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List records

Lists the submitted records (responses) of a form, one page at a time, optionally sorted by a field. Returns each record's ID and field values.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.
Pagepagenumber
To get the records from the respective pages. The default value is 1.From 1 to 10000.
Limitlimitnumber
To limit the number of records returned per page. The maximum value is 100.From 1 to 100.
Sort bysort_bytext
To sort the records by a specific field. Pass the API name of the field to sort by.
Sort ordersort_ordertext
To specify the order in which records are sorted, based on the field provided in sort_by. Allowed values: asc, desc.One of: asc, desc.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List report records

Lists the records shown in one of a form's reports, by form ID and report ID, one page at a time and optionally sorted by a field.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.
Reportreport_idtextRequired
The unique ID of the report whose records you want to retrieve. Get it from List reports.
Pagepagenumber
The page of records to return, starting at 1. page multiplied by limit cannot exceed 100,000. The default value is 1.From 1 to 10000.
Limitlimitnumber
To limit the number of records returned per page. The maximum value is 100. The default value is 50.From 1 to 100.
Sort bysort_bytext
API name of the field to sort the records by, from Get form details. Fields inside a grid and system fields such as ADDED_TIME are allowed; subform fields are not. The default value is ADDED_TIME.
Sort ordersort_ordertext
The order in which records are sorted, based on the field in sort_by. The default value is desc.One of: asc, desc.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List reports

Lists the reports set up on a form, one page at a time, optionally searched by name and sorted. Returns each report's ID and name.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.
Pagepagenumber
The page of reports to return, starting at 1. The default value is 1.From 1 to 10000.
Limitlimitnumber
The number of reports to return per page. The maximum value is 100. The default value is 50.From 1 to 100.
Searchsearchtext
Text to search for in report names. The search is not case-sensitive, and a report matches if its display_name contains the text.
Sort bysort_bytext
The field to sort the reports by. The default value is created_time.One of: created_time, modified_time, display_name.
Sort ordersort_ordertext
The order in which reports are sorted, based on the field in sort_by. The default value is desc.One of: asc, desc.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Search records

Searches a form's records for those matching the conditions you give, with optional fields to return, sorting and paging. Returns the matching records.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.
Searchsearchobject
Conditions that records must match.
Fieldsfieldslist
Fields to return.
Sort bysort_bylist
Fields to sort by.
Pagepagenumber
Page to return.From 1 to 10000.
Limitlimitnumber
Records per page.From 1 to 100.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Search report records

Searches the records in one of a form's reports for those matching the conditions you give, with optional fields to return, sorting and paging.

Inputs

Formform_idtextRequired
The unique ID of a form you own. Get it from List forms.
Reportreport_idtextRequired
The unique ID of the report whose records you want to retrieve. Get it from List reports.
Searchsearchobject
Conditions that records must match.
Fieldsfieldslist
Fields to return.
Sort bysort_bylist
Fields to sort by.
Pagepagenumber
Page to return.From 1 to 10000.
Limitlimitnumber
Records per page.From 1 to 100.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page