Skip to content

Responses Object ​



id
string

The unique identifier of the response.

name
string

The name of the response.

status
string

The status of the form response.

All possible enum values:
  • initiated
  • completed
  • submitted
answers
object[]

The answers submitted

field
object
id
string

The field's unique identifier.

name
string

The field's name.

label
string

The field's label.

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
  • scale
  • ranking
  • group
  • matrix
field_group
object

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

id
string

The field groups's identifier

name
string

The field groups's name

value
string

The value for the field submitted

created_by
object

User who created the response.

id
string

The unique identifier for a user

name
string

The name of the user

form
object

The form to which the response belongs.

id
string

The unique identifier of the form.

name
string

The name of the form.

workspace
object

The workspace to which the response belongs.

id
string

The unique identifier of the workspace.

name
string

The name of the workspace.

organization
object

The organization to which the response belongs.

id
string

The unique identifier of the organization.

name
string

The name of the organization.

opened_at
string · date-time

The date and time when the form was opened.

created_at
string · date-time

The date and time when the response was created.

updated_at
string · date-time

The date and time when the response was last updated.

remote_data
object

Raw data returned from the remote API call.