Appearance

List Fields ​

Endpoint ​

http
GET /unified/forms/fields
Integrations supported
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
form
object
Integration specific notes
  • TypeformThe form to which the response belongs.
  • Survey MonkeyThe form to which the response belongs.
  • JotformThe fields associated with the form.
  • Google FormsThe form to which the response belongs.
Required in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
id
string
REQUIRED · 

The unique identifier of the form.

Response Body ​

result
object[]

List of Fields

id
string

The field's unique identifier

Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
name
string

The field's name. This is the name of the property in the entity.

Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
label
string

The field's label

Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
placeholder
string

The field's placeholder

Supported in
  • Jotform
  • Survey Monkey
description
string

The field's description

Supported in
  • Google Forms
  • Jotform
position
number

The index position of field in the form.

Supported in
  • Jotform
  • Survey Monkey
type
string

The field's type. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • statement
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • rating
  • slider
  • scale
  • ranking
  • group
  • matrix_single
  • matrix_multiple
Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
format
string

The format of the field.

All possible enum values:
  • url
  • email
  • password
Supported in
  • Google Forms
  • Jotform
  • Typeform
validation
string

The validation string for the field.

Supported in
  • Survey Monkey
  • Typeform
range
object

The range applicable for field types number, rating, scale.

Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
min
number

The minimum range for the field.

min_label
number

The label for the minimum range of the field.

max
number

The maximum range for the field.

max_label
number

The label for the maximum range of the field.

is_required
boolean

Whether the field is required

Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
options
object[]

The field's options

Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
label
string

The option's label

value
string

The option's value

description
string

The option's description

field_group
object

The field's group identifier. If present, the field is part of a group.

Supported in
  • Google Forms
  • Jotform
  • Survey Monkey
  • Typeform
id
string

The field groups's identifier

name
string

The field groups's name

label
string

The field group's label

description
string

The field group's description

position
number

The index position of field group in the form.

rows
object[]

The field's rows. If present, the field's type is matrix

Supported in
  • Jotform
  • Survey Monkey
label
string

The row's label

value
string

The row's value

description
string

The row's description

columns
object[]

The field's columns. If present, the field's type is matrix

Supported in
  • Jotform
  • Survey Monkey
label
string

The column's label

value
string

The column's value

description
string

The column's description

created_at
string · date-time

The date and time of the field's creation

updated_at
string · date-time

The date and time of the field's last update

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.