Forms
Integrate with DECA Forms API
Triggers
Events from this node that can start a flow. Add one from Choose a trigger.
Response Created
Triggered when a response is created on a specific form
Settings
No settings.
Output
Later steps use this data through Current Trigger in the $ picker. For example, form.id is $trigger.output.form.id.
{
"form": {
"id": "string",
"name": "string"
},
"createdBy": {
"ip": "string",
"userAgent": "string",
"profile": {}
},
"answers": [
{
"question": {
"id": "string",
"label": "string",
"type": "string"
},
"page": {
"id": "string",
"name": {}
},
"response": {
"id": "string",
"answers": [],
"flatAnswer": "string",
"normalizedAnswer": "string"
}
}
],
"createdAt": "2026-01-01T09:00:00Z",
"nonInputQuestions": [
"string"
]
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
form | Object | Form information |
form.id | Text | Unique identifier for the form |
form.name | Text | Form name |
createdBy | Object | Information about the creator of this response |
createdBy.ip | Text | IP address of the respondent |
createdBy.userAgent | Text | User agent of the respondent's browser |
createdBy.profile | Object | User profile if provided |
answers[] | List | List of answers for questions |
answers[].question | Object | |
answers[].question.id | Text | |
answers[].question.label | Text | |
answers[].question.type | Text | |
answers[].page | Object | |
answers[].page.id | Text | |
answers[].page.name | Object | |
answers[].page.name.name | Text | |
answers[].page.name.is_visible | Yes / No | |
answers[].response | Object | |
answers[].response.id | Text | |
answers[].response.answers[] | List | |
answers[].response.answers[].value | Text | |
answers[].response.answers[].is_other | Yes / No | |
answers[].response.answers[].asset | Object | |
answers[].response.flatAnswer | Text | |
answers[].response.normalizedAnswer | Text | |
createdAt | Text | Response created at timestamp |
nonInputQuestions[] | List | List of non-input questions in the form. Elements are free-form question objects |
Form Created
Triggered when a form is created
Settings
No settings.
Output
Later steps use this data through Current Trigger in the $ picker. For example, id is $trigger.output.id.
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Unique identifier for the form |
name | Text | Name of the form |
start_at | Text | Start time of the form |
expired_at | Text | Expired time of the form |
appearance | Object | Form appearance settings |
appearance.header_style | Object | Header appearance settings |
appearance.header_style.logo_align | Text | Logo alignment position |
appearance.header_style.logo_size | Text | Size of the logo |
appearance.header_style.logo_image | Text | URL or path to the logo image |
appearance.header_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.header_style.text | Text | Header text content |
appearance.header_style.position | Text | Header position |
appearance.footer_style | Object | Footer appearance settings |
appearance.footer_style.logo_align | Text | Logo alignment position |
appearance.footer_style.logo_size | Text | Size of the logo |
appearance.footer_style.logo_image | Text | URL or path to the logo image |
appearance.footer_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.footer_style.text | Text | Footer text content |
appearance.form_field_style | Object | Form field appearance settings |
appearance.form_field_style.color | Object | Color settings for form fields |
appearance.form_field_style.color.question | Text | Question text color |
appearance.form_field_style.color.answer | Text | Answer text color |
appearance.form_field_style.color.icon | Text | Icon color |
appearance.form_field_style.color.description | Text | Description text color |
appearance.form_field_style.color.placeholder | Text | Placeholder text color |
appearance.form_field_style.color.field_stroke | Text | Field border color |
appearance.form_field_style.color.field_background | Text | Field background color |
appearance.form_field_style.font_family | Object | Font family settings for form fields |
appearance.form_field_style.font_family.question | Text | Question font family |
appearance.form_field_style.font_family.answer | Text | Answer font family |
appearance.form_field_style.font_family.text | Text | Text font family |
appearance.form_field_style.font_size | Object | Font size settings for form fields |
appearance.form_field_style.font_size.question | Number | Question font size in pixels |
appearance.form_field_style.font_size.answer | Number | Answer font size in pixels |
appearance.form_field_style.font_size.text | Number | Text font size in pixels |
appearance.button_style | Object | Button appearance settings |
appearance.button_style.type | Text | Button type |
appearance.button_style.full_width | Yes / No | Whether button should take full width |
appearance.button_style.background_color | Text | Button background color |
appearance.button_style.text_color | Text | Button text color |
appearance.button_style.font_family | Text | Button font family |
appearance.button_style.font_size | Number | Button font size in pixels |
appearance.heading_style | Object | Heading appearance settings |
appearance.heading_style.font_family | Text | Heading font family |
appearance.heading_style.font_size | Number | Heading font size in pixels |
appearance.heading_style.color | Text | Heading text color |
appearance.paragraph_style | Object | Paragraph appearance settings |
appearance.paragraph_style.font_family | Text | Paragraph font family |
appearance.paragraph_style.font_size | Number | Paragraph font size in pixels |
appearance.paragraph_style.color | Text | Paragraph text color |
appearance.customize | Yes / No | Whether appearance is customized |
appearance.default_settings | Object | Default appearance settings |
appearance.default_settings.color | Text | Default color |
appearance.default_settings.font_family | Text | Default font family |
appearance.default_settings.input_style | Text | Default input field style |
metadata | Object | Form metadata |
metadata.organization_id | Text | Unique identifier for the organization |
metadata.workspace_id | Text | Unique identifier for the workspace |
metadata.org_name | Text | Name of the organization |
is_template | Yes / No | Whether the form is a template |
screenshot | Object | Form thumbnail |
screenshot.original | Text | URL to the original screenshot image |
screenshot.thumbnail | Text | URL to the thumbnail version of the screenshot |
screenshot.preview | Text | URL to the preview version of the screenshot |
responses | Number | Number of responses |
status | Text | Form status |
setting | Object | Form settings |
Actions
Steps this node can perform. Add one from Add a step, then pick the action.
List Forms
List forms with optional filtering and pagination
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Is Favorited | Yes / No | Select favorited forms Default: false | |
| Template Source | Choice | Select template source when is_template true Options: General, WorkspaceDefault: general | |
| Search | Text | Search term to filter forms | |
| Filter | Text | Filter by a JSON object | |
| Sort | Text | Sort by field_name for ASC or -field_name for DESC, multiple values are supported by "," separator | |
| Page | Number | Selected page for list display Default: 1 | |
| Per Page | Number | Number of item per page Default: 10 |
Output
Later steps use this data by picking this step in the $ picker. For example, responses[0].id is $.<step ID>.output.responses[0].id.
{
"responses": [
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}
],
"pagination": {
"total_item": 0,
"total_page": 0,
"per_page": 0,
"current_page": 0
}
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
responses[] | List | List of forms |
responses[].id | Text | Unique identifier for the form |
responses[].name | Text | Name of the form |
responses[].start_at | Text | Start time of the form |
responses[].expired_at | Text | Expired time of the form |
responses[].appearance | Object | Form appearance settings |
responses[].appearance.header_style | Object | Header appearance settings |
responses[].appearance.header_style.logo_align | Text | Logo alignment position |
responses[].appearance.header_style.logo_size | Text | Size of the logo |
responses[].appearance.header_style.logo_image | Text | URL or path to the logo image |
responses[].appearance.header_style.is_using_text | Yes / No | Whether to use text instead of logo |
responses[].appearance.header_style.text | Text | Header text content |
responses[].appearance.header_style.position | Text | Header position |
responses[].appearance.footer_style | Object | Footer appearance settings |
responses[].appearance.footer_style.logo_align | Text | Logo alignment position |
responses[].appearance.footer_style.logo_size | Text | Size of the logo |
responses[].appearance.footer_style.logo_image | Text | URL or path to the logo image |
responses[].appearance.footer_style.is_using_text | Yes / No | Whether to use text instead of logo |
responses[].appearance.footer_style.text | Text | Footer text content |
responses[].appearance.form_field_style | Object | Form field appearance settings |
responses[].appearance.form_field_style.color | Object | Color settings for form fields |
responses[].appearance.form_field_style.font_family | Object | Font family settings for form fields |
responses[].appearance.form_field_style.font_size | Object | Font size settings for form fields |
responses[].appearance.button_style | Object | Button appearance settings |
responses[].appearance.button_style.type | Text | Button type |
responses[].appearance.button_style.full_width | Yes / No | Whether button should take full width |
responses[].appearance.button_style.background_color | Text | Button background color |
responses[].appearance.button_style.text_color | Text | Button text color |
responses[].appearance.button_style.font_family | Text | Button font family |
responses[].appearance.button_style.font_size | Number | Button font size in pixels |
responses[].appearance.heading_style | Object | Heading appearance settings |
responses[].appearance.heading_style.font_family | Text | Heading font family |
responses[].appearance.heading_style.font_size | Number | Heading font size in pixels |
responses[].appearance.heading_style.color | Text | Heading text color |
responses[].appearance.paragraph_style | Object | Paragraph appearance settings |
responses[].appearance.paragraph_style.font_family | Text | Paragraph font family |
responses[].appearance.paragraph_style.font_size | Number | Paragraph font size in pixels |
responses[].appearance.paragraph_style.color | Text | Paragraph text color |
responses[].appearance.customize | Yes / No | Whether appearance is customized |
responses[].appearance.default_settings | Object | Default appearance settings |
responses[].appearance.default_settings.color | Text | Default color |
responses[].appearance.default_settings.font_family | Text | Default font family |
responses[].appearance.default_settings.input_style | Text | Default input field style |
responses[].metadata | Object | Form metadata |
responses[].metadata.organization_id | Text | Unique identifier for the organization |
responses[].metadata.workspace_id | Text | Unique identifier for the workspace |
responses[].metadata.org_name | Text | Name of the organization |
responses[].is_template | Yes / No | Whether the form is a template |
responses[].screenshot | Object | Form thumbnail |
responses[].screenshot.original | Text | URL to the original screenshot image |
responses[].screenshot.thumbnail | Text | URL to the thumbnail version of the screenshot |
responses[].screenshot.preview | Text | URL to the preview version of the screenshot |
responses[].responses | Number | Number of responses |
responses[].status | Text | Form status |
responses[].setting | Object | Form settings |
pagination | Object | Pagination information |
pagination.total_item | Number | Total number of items |
pagination.total_page | Number | Total number of pages |
pagination.per_page | Number | Number of items per page |
pagination.current_page | Number | Current page number |
Retrieve Form
Retrieve the form detail by form ID or form slug
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID or form slug to retrieve |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Unique identifier for the form |
name | Text | Name of the form |
start_at | Text | Start time of the form |
expired_at | Text | Expired time of the form |
appearance | Object | Form appearance settings |
appearance.header_style | Object | Header appearance settings |
appearance.header_style.logo_align | Text | Logo alignment position |
appearance.header_style.logo_size | Text | Size of the logo |
appearance.header_style.logo_image | Text | URL or path to the logo image |
appearance.header_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.header_style.text | Text | Header text content |
appearance.header_style.position | Text | Header position |
appearance.footer_style | Object | Footer appearance settings |
appearance.footer_style.logo_align | Text | Logo alignment position |
appearance.footer_style.logo_size | Text | Size of the logo |
appearance.footer_style.logo_image | Text | URL or path to the logo image |
appearance.footer_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.footer_style.text | Text | Footer text content |
appearance.form_field_style | Object | Form field appearance settings |
appearance.form_field_style.color | Object | Color settings for form fields |
appearance.form_field_style.color.question | Text | Question text color |
appearance.form_field_style.color.answer | Text | Answer text color |
appearance.form_field_style.color.icon | Text | Icon color |
appearance.form_field_style.color.description | Text | Description text color |
appearance.form_field_style.color.placeholder | Text | Placeholder text color |
appearance.form_field_style.color.field_stroke | Text | Field border color |
appearance.form_field_style.color.field_background | Text | Field background color |
appearance.form_field_style.font_family | Object | Font family settings for form fields |
appearance.form_field_style.font_family.question | Text | Question font family |
appearance.form_field_style.font_family.answer | Text | Answer font family |
appearance.form_field_style.font_family.text | Text | Text font family |
appearance.form_field_style.font_size | Object | Font size settings for form fields |
appearance.form_field_style.font_size.question | Number | Question font size in pixels |
appearance.form_field_style.font_size.answer | Number | Answer font size in pixels |
appearance.form_field_style.font_size.text | Number | Text font size in pixels |
appearance.button_style | Object | Button appearance settings |
appearance.button_style.type | Text | Button type |
appearance.button_style.full_width | Yes / No | Whether button should take full width |
appearance.button_style.background_color | Text | Button background color |
appearance.button_style.text_color | Text | Button text color |
appearance.button_style.font_family | Text | Button font family |
appearance.button_style.font_size | Number | Button font size in pixels |
appearance.heading_style | Object | Heading appearance settings |
appearance.heading_style.font_family | Text | Heading font family |
appearance.heading_style.font_size | Number | Heading font size in pixels |
appearance.heading_style.color | Text | Heading text color |
appearance.paragraph_style | Object | Paragraph appearance settings |
appearance.paragraph_style.font_family | Text | Paragraph font family |
appearance.paragraph_style.font_size | Number | Paragraph font size in pixels |
appearance.paragraph_style.color | Text | Paragraph text color |
appearance.customize | Yes / No | Whether appearance is customized |
appearance.default_settings | Object | Default appearance settings |
appearance.default_settings.color | Text | Default color |
appearance.default_settings.font_family | Text | Default font family |
appearance.default_settings.input_style | Text | Default input field style |
metadata | Object | Form metadata |
metadata.organization_id | Text | Unique identifier for the organization |
metadata.workspace_id | Text | Unique identifier for the workspace |
metadata.org_name | Text | Name of the organization |
is_template | Yes / No | Whether the form is a template |
screenshot | Object | Form thumbnail |
screenshot.original | Text | URL to the original screenshot image |
screenshot.thumbnail | Text | URL to the thumbnail version of the screenshot |
screenshot.preview | Text | URL to the preview version of the screenshot |
responses | Number | Number of responses |
status | Text | Form status |
setting | Object | Form settings |
Create Form
Create a new form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Name | Text | Yes | Form name |
| Tags | List | Form tags | |
| Form Start At | Date and time | Form start date & time | |
| Expired At | Date and time | Form end date & time |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Unique identifier for the form |
name | Text | Name of the form |
start_at | Text | Start time of the form |
expired_at | Text | Expired time of the form |
appearance | Object | Form appearance settings |
appearance.header_style | Object | Header appearance settings |
appearance.header_style.logo_align | Text | Logo alignment position |
appearance.header_style.logo_size | Text | Size of the logo |
appearance.header_style.logo_image | Text | URL or path to the logo image |
appearance.header_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.header_style.text | Text | Header text content |
appearance.header_style.position | Text | Header position |
appearance.footer_style | Object | Footer appearance settings |
appearance.footer_style.logo_align | Text | Logo alignment position |
appearance.footer_style.logo_size | Text | Size of the logo |
appearance.footer_style.logo_image | Text | URL or path to the logo image |
appearance.footer_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.footer_style.text | Text | Footer text content |
appearance.form_field_style | Object | Form field appearance settings |
appearance.form_field_style.color | Object | Color settings for form fields |
appearance.form_field_style.color.question | Text | Question text color |
appearance.form_field_style.color.answer | Text | Answer text color |
appearance.form_field_style.color.icon | Text | Icon color |
appearance.form_field_style.color.description | Text | Description text color |
appearance.form_field_style.color.placeholder | Text | Placeholder text color |
appearance.form_field_style.color.field_stroke | Text | Field border color |
appearance.form_field_style.color.field_background | Text | Field background color |
appearance.form_field_style.font_family | Object | Font family settings for form fields |
appearance.form_field_style.font_family.question | Text | Question font family |
appearance.form_field_style.font_family.answer | Text | Answer font family |
appearance.form_field_style.font_family.text | Text | Text font family |
appearance.form_field_style.font_size | Object | Font size settings for form fields |
appearance.form_field_style.font_size.question | Number | Question font size in pixels |
appearance.form_field_style.font_size.answer | Number | Answer font size in pixels |
appearance.form_field_style.font_size.text | Number | Text font size in pixels |
appearance.button_style | Object | Button appearance settings |
appearance.button_style.type | Text | Button type |
appearance.button_style.full_width | Yes / No | Whether button should take full width |
appearance.button_style.background_color | Text | Button background color |
appearance.button_style.text_color | Text | Button text color |
appearance.button_style.font_family | Text | Button font family |
appearance.button_style.font_size | Number | Button font size in pixels |
appearance.heading_style | Object | Heading appearance settings |
appearance.heading_style.font_family | Text | Heading font family |
appearance.heading_style.font_size | Number | Heading font size in pixels |
appearance.heading_style.color | Text | Heading text color |
appearance.paragraph_style | Object | Paragraph appearance settings |
appearance.paragraph_style.font_family | Text | Paragraph font family |
appearance.paragraph_style.font_size | Number | Paragraph font size in pixels |
appearance.paragraph_style.color | Text | Paragraph text color |
appearance.customize | Yes / No | Whether appearance is customized |
appearance.default_settings | Object | Default appearance settings |
appearance.default_settings.color | Text | Default color |
appearance.default_settings.font_family | Text | Default font family |
appearance.default_settings.input_style | Text | Default input field style |
metadata | Object | Form metadata |
metadata.organization_id | Text | Unique identifier for the organization |
metadata.workspace_id | Text | Unique identifier for the workspace |
metadata.org_name | Text | Name of the organization |
is_template | Yes / No | Whether the form is a template |
screenshot | Object | Form thumbnail |
screenshot.original | Text | URL to the original screenshot image |
screenshot.thumbnail | Text | URL to the thumbnail version of the screenshot |
screenshot.preview | Text | URL to the preview version of the screenshot |
responses | Number | Number of responses |
status | Text | Form status |
setting | Object | Form settings |
Update Form
Update an existing form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to update |
| Name | Text | Form name | |
| Tags | List | Form tags | |
| Start At | Date and time | Form start date & time | |
| Expired At | Date and time | Form end date & time | |
| Status | Choice | Form status Options: Draft, Active, ClosedDefault: draft | |
| Is Pinned | Yes / No | Form is pinned |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"name": "string",
"start_at": "2026-01-01T09:00:00Z",
"expired_at": "2026-01-01T09:00:00Z",
"appearance": "string",
"metadata": {
"organization_id": "string",
"workspace_id": "string",
"org_name": "string"
},
"is_template": false,
"screenshot": {
"original": "string",
"thumbnail": "string",
"preview": "string"
},
"responses": 0,
"status": "draft",
"setting": {}
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Unique identifier for the form |
name | Text | Name of the form |
start_at | Text | Start time of the form |
expired_at | Text | Expired time of the form |
appearance | Object | Form appearance settings |
appearance.header_style | Object | Header appearance settings |
appearance.header_style.logo_align | Text | Logo alignment position |
appearance.header_style.logo_size | Text | Size of the logo |
appearance.header_style.logo_image | Text | URL or path to the logo image |
appearance.header_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.header_style.text | Text | Header text content |
appearance.header_style.position | Text | Header position |
appearance.footer_style | Object | Footer appearance settings |
appearance.footer_style.logo_align | Text | Logo alignment position |
appearance.footer_style.logo_size | Text | Size of the logo |
appearance.footer_style.logo_image | Text | URL or path to the logo image |
appearance.footer_style.is_using_text | Yes / No | Whether to use text instead of logo |
appearance.footer_style.text | Text | Footer text content |
appearance.form_field_style | Object | Form field appearance settings |
appearance.form_field_style.color | Object | Color settings for form fields |
appearance.form_field_style.color.question | Text | Question text color |
appearance.form_field_style.color.answer | Text | Answer text color |
appearance.form_field_style.color.icon | Text | Icon color |
appearance.form_field_style.color.description | Text | Description text color |
appearance.form_field_style.color.placeholder | Text | Placeholder text color |
appearance.form_field_style.color.field_stroke | Text | Field border color |
appearance.form_field_style.color.field_background | Text | Field background color |
appearance.form_field_style.font_family | Object | Font family settings for form fields |
appearance.form_field_style.font_family.question | Text | Question font family |
appearance.form_field_style.font_family.answer | Text | Answer font family |
appearance.form_field_style.font_family.text | Text | Text font family |
appearance.form_field_style.font_size | Object | Font size settings for form fields |
appearance.form_field_style.font_size.question | Number | Question font size in pixels |
appearance.form_field_style.font_size.answer | Number | Answer font size in pixels |
appearance.form_field_style.font_size.text | Number | Text font size in pixels |
appearance.button_style | Object | Button appearance settings |
appearance.button_style.type | Text | Button type |
appearance.button_style.full_width | Yes / No | Whether button should take full width |
appearance.button_style.background_color | Text | Button background color |
appearance.button_style.text_color | Text | Button text color |
appearance.button_style.font_family | Text | Button font family |
appearance.button_style.font_size | Number | Button font size in pixels |
appearance.heading_style | Object | Heading appearance settings |
appearance.heading_style.font_family | Text | Heading font family |
appearance.heading_style.font_size | Number | Heading font size in pixels |
appearance.heading_style.color | Text | Heading text color |
appearance.paragraph_style | Object | Paragraph appearance settings |
appearance.paragraph_style.font_family | Text | Paragraph font family |
appearance.paragraph_style.font_size | Number | Paragraph font size in pixels |
appearance.paragraph_style.color | Text | Paragraph text color |
appearance.customize | Yes / No | Whether appearance is customized |
appearance.default_settings | Object | Default appearance settings |
appearance.default_settings.color | Text | Default color |
appearance.default_settings.font_family | Text | Default font family |
appearance.default_settings.input_style | Text | Default input field style |
metadata | Object | Form metadata |
metadata.organization_id | Text | Unique identifier for the organization |
metadata.workspace_id | Text | Unique identifier for the workspace |
metadata.org_name | Text | Name of the organization |
is_template | Yes / No | Whether the form is a template |
screenshot | Object | Form thumbnail |
screenshot.original | Text | URL to the original screenshot image |
screenshot.thumbnail | Text | URL to the thumbnail version of the screenshot |
screenshot.preview | Text | URL to the preview version of the screenshot |
responses | Number | Number of responses |
status | Text | Form status |
setting | Object | Form settings |
Delete Form
Delete a form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to delete |
Output
No documented output fields.
Duplicate Form
Duplicate a form for a specific workspace
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to duplicate |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"external_id": "string",
"fn": "string",
"status": "string",
"delay": 0,
"result": {},
"created_at": "2026-01-01T09:00:00Z",
"updated_at": "2026-01-01T09:00:00Z",
"started_at": "2026-01-01T09:00:00Z",
"finished_at": "2026-01-01T09:00:00Z"
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Task ID, this is the internal id |
external_id | Text | Task ID, this is the external id |
fn | Text | Task function |
status | Text | Task status |
delay | Number | Task delay |
result | Object | Task result |
created_at | Text | Task creation timestamp |
updated_at | Text | Task last update timestamp |
started_at | Text | Task start timestamp |
finished_at | Text | Task finish timestamp |
List all form pages
List forms with optional filtering and pagination
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to list all pages |
Output
Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.
[
{
"id": "string",
"name": "string",
"layout": {
"type": "image-top-with-space",
"image_url": "string",
"field_width": "string",
"show_progress_bar": false
},
"type": "section",
"index": 0,
"created_at": "2026-01-01T09:00:00Z",
"updated_at": "2026-01-01T09:00:00Z",
"content": [
{
"id": "string",
"index": 0,
"type": "short_qa",
"label": "string",
"name": "string",
"is_other": false,
"is_hide": false,
"time_format": "string",
"date_format": "string",
"dob_enabled": false,
"input_directly_enabled": false,
"fixed_date_title_enabled": false,
"description": "string",
"icon": "string",
"right_icon": false,
"supported_types": [],
"theme": "small",
"footer_hide": false,
"max_scale": 0,
"show_number": true,
"footer_label": {},
"shape": "star",
"description_enabled": false,
"hide_label": false,
"placeholder": "string",
"validators": [],
"style": {},
"layout": "one_column",
"options": [],
"fields": []
}
]
}
]Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Page ID |
name | Text | Page name |
layout | Object | Page layout configuration |
layout.type | Choice | Layout type |
layout.image_url | Text | URL for layout image |
layout.field_width | Text | Width of form fields |
layout.show_progress_bar | Yes / No | Whether to show progress bar |
type | Text | Page type |
index | Number | Page order index |
created_at | Text | Page creation timestamp |
updated_at | Text | Page last update timestamp |
content[] | List | List of questions on the page |
content[].id | Text | Unique identifier for the question |
content[].index | Number | Order index of the question |
content[].type | Text | Type of the question |
content[].label | Text | Question label |
content[].name | Text | Question name |
content[].is_other | Yes / No | Whether this is an 'other' option |
content[].is_hide | Yes / No | Whether the question is hidden |
content[].time_format | Text | Time format for time-related questions |
content[].date_format | Text | Date format for date-related questions |
content[].dob_enabled | Yes / No | Whether date of birth is enabled |
content[].input_directly_enabled | Yes / No | Whether direct input is enabled |
content[].fixed_date_title_enabled | Yes / No | Whether fixed date title is enabled |
content[].description | Text | Question description |
content[].icon | Text | Question icon |
content[].right_icon | Yes / No | Whether icon is positioned on the right |
content[].supported_types[] | List | Supported file types for file upload questions |
content[].theme | Text | File upload theme size |
content[].footer_hide | Yes / No | Whether to hide the footer |
content[].max_scale | Number | Maximum scale value for rating questions |
content[].show_number | Yes / No | Whether to show question number |
content[].footer_label | Object | Footer label configuration |
content[].footer_label.left | Text | Left footer label |
content[].footer_label.middle | Text | Middle footer label |
content[].footer_label.right | Text | Right footer label |
content[].shape | Text | Rating shape for rating questions |
content[].description_enabled | Yes / No | Whether description is enabled |
content[].hide_label | Yes / No | Whether to hide the label |
content[].placeholder | Text | Placeholder text for the question |
content[].validators[] | List | Question validation rules |
content[].validators[].type | Text | Validator type |
content[].validators[].value | Object | Validator value |
content[].validators[].message | Text | Validation error message |
content[].style | Object | Question styling configuration |
content[].layout | Text | Question layout configuration |
content[].options[] | List | Question options for choice-based questions |
content[].options[].label | Text | Option label |
content[].options[].default_check | Yes / No | Whether this option is checked by default |
content[].options[].image_url | Text | URL for option image |
content[].fields[] | List | Sub-fields for complex questions |
List all questions of a form
List all questions of a form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to list all questions |
| Search | Text | Search term to filter questions | |
| Filter | Text | Filter by a JSON object | |
| Sort | Text | Sort by field_name for ASC or -field_name for DESC, multiple values are supported by "," separator |
Output
Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.
[
{
"id": "string",
"page_id": "string",
"form_id": "string",
"page_name": "string",
"name": "string",
"label": "string",
"label_text": "string",
"type": "short_qa",
"options": [],
"is_deleted": false,
"is_hidden": false,
"is_pinned": false
}
]Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Unique identifier for the question |
page_id | Text | ID of the page containing the question |
form_id | Text | ID of the form containing the question |
page_name | Text | Name of the page containing the question |
name | Text | Question name |
label | Text | Question label |
label_text | Text | Question label without HTML tags |
type | Text | Type of the question |
options[] | List | Question options for choice-based questions |
is_deleted | Yes / No | Whether the question is deleted |
is_hidden | Yes / No | Whether the question is hidden |
is_pinned | Yes / No | Whether the question is pinned |
Update Form Page
Update a form page
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to update pages for |
| Pages | List | Yes | Array of page updates |
Output
Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.
[
{
"id": "string",
"name": "string",
"layout": {
"type": "image-top-with-space",
"image_url": "string",
"field_width": "string",
"show_progress_bar": false
},
"type": "section",
"index": 0,
"created_at": "2026-01-01T09:00:00Z",
"updated_at": "2026-01-01T09:00:00Z",
"content": [
{
"id": "string",
"index": 0,
"type": "short_qa",
"label": "string",
"name": "string",
"is_other": false,
"is_hide": false,
"time_format": "string",
"date_format": "string",
"dob_enabled": false,
"input_directly_enabled": false,
"fixed_date_title_enabled": false,
"description": "string",
"icon": "string",
"right_icon": false,
"supported_types": [],
"theme": "small",
"footer_hide": false,
"max_scale": 0,
"show_number": true,
"footer_label": {},
"shape": "star",
"description_enabled": false,
"hide_label": false,
"placeholder": "string",
"validators": [],
"style": {},
"layout": "one_column",
"options": [],
"fields": []
}
]
}
]Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Page ID |
name | Text | Page name |
layout | Object | Page layout configuration |
layout.type | Choice | Layout type |
layout.image_url | Text | URL for layout image |
layout.field_width | Text | Width of form fields |
layout.show_progress_bar | Yes / No | Whether to show progress bar |
type | Text | Page type |
index | Number | Page order index |
created_at | Text | Page creation timestamp |
updated_at | Text | Page last update timestamp |
content[] | List | List of questions on the page |
content[].id | Text | Unique identifier for the question |
content[].index | Number | Order index of the question |
content[].type | Text | Type of the question |
content[].label | Text | Question label |
content[].name | Text | Question name |
content[].is_other | Yes / No | Whether this is an 'other' option |
content[].is_hide | Yes / No | Whether the question is hidden |
content[].time_format | Text | Time format for time-related questions |
content[].date_format | Text | Date format for date-related questions |
content[].dob_enabled | Yes / No | Whether date of birth is enabled |
content[].input_directly_enabled | Yes / No | Whether direct input is enabled |
content[].fixed_date_title_enabled | Yes / No | Whether fixed date title is enabled |
content[].description | Text | Question description |
content[].icon | Text | Question icon |
content[].right_icon | Yes / No | Whether icon is positioned on the right |
content[].supported_types[] | List | Supported file types for file upload questions |
content[].theme | Text | File upload theme size |
content[].footer_hide | Yes / No | Whether to hide the footer |
content[].max_scale | Number | Maximum scale value for rating questions |
content[].show_number | Yes / No | Whether to show question number |
content[].footer_label | Object | Footer label configuration |
content[].footer_label.left | Text | Left footer label |
content[].footer_label.middle | Text | Middle footer label |
content[].footer_label.right | Text | Right footer label |
content[].shape | Text | Rating shape for rating questions |
content[].description_enabled | Yes / No | Whether description is enabled |
content[].hide_label | Yes / No | Whether to hide the label |
content[].placeholder | Text | Placeholder text for the question |
content[].validators[] | List | Question validation rules |
content[].validators[].type | Text | Validator type |
content[].validators[].value | Object | Validator value |
content[].validators[].message | Text | Validation error message |
content[].style | Object | Question styling configuration |
content[].layout | Text | Question layout configuration |
content[].options[] | List | Question options for choice-based questions |
content[].options[].label | Text | Option label |
content[].options[].default_check | Yes / No | Whether this option is checked by default |
content[].options[].image_url | Text | URL for option image |
content[].fields[] | List | Sub-fields for complex questions |
List Responses
List all responses of a form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to list all responses |
Output
Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.
[
{
"id": "string",
"created_at": "2026-01-01T09:00:00Z",
"created_by": {
"ip": "string",
"user_agent": "string",
"profile": {
"id": "string",
"type": "line",
"name": "string",
"avatar": "string"
}
}
}
]Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Unique identifier for the response |
created_at | Text | Response creation timestamp |
created_by | Object | Information about who created the response |
created_by.ip | Text | IP address of the respondent |
created_by.user_agent | Text | User agent string of the respondent's browser |
created_by.profile | Object | LINE Profile if provided |
created_by.profile.id | Text | Unique identifier for the user profile |
created_by.profile.type | Text | Type of user profile (e.g., line, google, etc.) |
created_by.profile.name | Text | Display name of the user |
created_by.profile.avatar | Text | URL to the user's avatar image |
Retrieve Response
Retrieve a response of a form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to retrieve a response |
| Response ID | Text | Yes | The response ID to retrieve |
Output
No documented output fields.
Create Response
Create a response for a form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to create a response |
| Answers | List | Array of answers for the form questions |
Output
No documented output fields.
List Views
List all views of a form
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to list all views |
Output
Later steps use this data by picking this step in the $ picker. For example, [0].id is $.<step ID>.output.[0].id.
[
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}
]Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Result View ID |
name | Text | View Name |
columns[] | List | List of questions to be displayed in the view |
columns[].label | Text | Question label |
columns[].labelText | Text | Question label without html tags |
columns[].questionId | Text | Question ID |
columns[].type | Text | Question type |
columns[].isHidden | Yes / No | Question's hidden status |
columns[].isPinned | Yes / No | Question's pin status |
columns[].isDeleted | Yes / No | Is deleted |
filters | Object | Filters to be applied to the view |
isPrivate | Yes / No | Visibility of a view |
creatorId | Text | Result View Creator ID |
Retrieve View
Retrieve a view by view ID
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to retrieve a view |
| View ID | Text | Yes | The view ID to retrieve |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Result View ID |
name | Text | View Name |
columns[] | List | List of questions to be displayed in the view |
columns[].label | Text | Question label |
columns[].labelText | Text | Question label without html tags |
columns[].questionId | Text | Question ID |
columns[].type | Text | Question type |
columns[].isHidden | Yes / No | Question's hidden status |
columns[].isPinned | Yes / No | Question's pin status |
columns[].isDeleted | Yes / No | Is deleted |
filters | Object | Filters to be applied to the view |
isPrivate | Yes / No | Visibility of a view |
creatorId | Text | Result View Creator ID |
Create View
Create a new view
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to create a view |
| Name | Text | Yes | View Name |
| Columns | List | List of questions to be displayed in the view | |
| Filters | Object | Filters to be applied to the view |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Result View ID |
name | Text | View Name |
columns[] | List | List of questions to be displayed in the view |
columns[].label | Text | Question label |
columns[].labelText | Text | Question label without html tags |
columns[].questionId | Text | Question ID |
columns[].type | Text | Question type |
columns[].isHidden | Yes / No | Question's hidden status |
columns[].isPinned | Yes / No | Question's pin status |
columns[].isDeleted | Yes / No | Is deleted |
filters | Object | Filters to be applied to the view |
isPrivate | Yes / No | Visibility of a view |
creatorId | Text | Result View Creator ID |
Update View
Update a view
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to update a view |
| View ID | Text | Yes | The view ID to update |
| Name | Text | View Name | |
| Columns | List | List of questions to be displayed in the view | |
| Filters | Object | Filters to be applied to the view | |
| Is Private | Yes / No | Visibility of a view |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"name": "string",
"columns": [
{
"label": "string",
"labelText": "string",
"questionId": "string",
"type": "string",
"isHidden": false,
"isPinned": false,
"isDeleted": false
}
],
"filters": {},
"isPrivate": true,
"creatorId": "string"
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Result View ID |
name | Text | View Name |
columns[] | List | List of questions to be displayed in the view |
columns[].label | Text | Question label |
columns[].labelText | Text | Question label without html tags |
columns[].questionId | Text | Question ID |
columns[].type | Text | Question type |
columns[].isHidden | Yes / No | Question's hidden status |
columns[].isPinned | Yes / No | Question's pin status |
columns[].isDeleted | Yes / No | Is deleted |
filters | Object | Filters to be applied to the view |
isPrivate | Yes / No | Visibility of a view |
creatorId | Text | Result View Creator ID |
Delete View
Delete a view
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The form ID to delete a view |
| View ID | Text | Yes | The view ID to delete |
Output
No documented output fields.
List Tags
Retrieve a list of tags with optional filtering and pagination
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Search | Text | Search term to filter tags | |
| Filter | Text | Filter by a JSON object | |
| Sort | Text | Sort by field_name for ASC or -field_name for DESC, multiple values are supported by "," separator | |
| Page | Number | Selected page for list display Default: 1 | |
| Per Page | Number | Number of item per page Default: 10 |
Output
Later steps use this data by picking this step in the $ picker. For example, responses[0].id is $.<step ID>.output.responses[0].id.
{
"responses": [
{
"id": "string",
"name": "string",
"is_category": false
}
],
"pagination": {
"total_item": 0,
"total_page": 0,
"per_page": 0,
"current_page": 0
}
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
responses[] | List | List of tags |
responses[].id | Text | Tag ID |
responses[].name | Text | Tag name |
responses[].is_category | Yes / No | Tag is category |
pagination | Object | Pagination information |
pagination.total_item | Number | Total number of items |
pagination.total_page | Number | Total number of pages |
pagination.per_page | Number | Number of items per page |
pagination.current_page | Number | Current page number |
Retrieve Tag
Get detailed information about a specific tag
Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Resource ID | Text | Yes | The tag ID to retrieve |
Output
Later steps use this data by picking this step in the $ picker. For example, id is $.<step ID>.output.id.
{
"id": "string",
"name": "string",
"is_category": false
}Example values show the shape of the data, not real values. See Using data from earlier steps.
Field descriptions
| Field | Type | Description |
|---|---|---|
id | Text | Tag ID |
name | Text | Tag name |
is_category | Yes / No | Tag is category |