Learn more about the other types used when reading, creating, updating, and deleting forms via the API
The monday.com form API lets you query a form’s configuration, appearance, and behavior. With it, you can programmatically access settings such as accessibility, visual styles, features, questions, and tags.
Each of the object types described below represents a specific aspect of a form. They can be queried as subfields on the form query or provide form metadata in mutations.
CreateQuestionInput
An object containing the form question's properties.
Field | Description | Supported Fields |
|---|---|---|
description | The question's description. | |
options [QuestionOptionInput!] | label | |
required | Whether the question must be answered to submit the form. | |
settings FormQuestionSettingsInput | The question's type-specific settings. | checkedByDefault |
title | The question's title. | |
type FormQuestionType! | The question's type. Determines input behavior and validation. | |
visible | Whether the question is visible to respondents. Hidden questions remain in the form structure but aren't displayed to respondents. The default is |
QuestionOptionInput
An array of objects defining labels for choice-based option questions.
| Field | Description |
|---|---|
label String! | The option's label to display. |
DehydratedFormResponse
An object containing the result of creating a new form via the API.
| Field | Description |
|---|---|
boardId ID! | The unique identifier of the board connected to the form. |
token String! | The form's unique identifier. |
DeleteFormTagInput
Defines the options for deleting a tag from a form via the API.
| Field | Description |
|---|---|
deleteAssociatedColumn Boolean | Whether the associated column should be deleted. |
FormAccessibility
An object containing the form's accessibility options.
| Field | Description |
|---|---|
language String | The language code for the form's localization and interface text (e.g., "es", "en", "fr"). |
logoAltText String | The form's logo image alternative text description. |
FormAppearance
An object containing the form’s overall visual appearance (e.g., background, layout, colors, typography).
Field | Description | Supported fields |
|---|---|---|
background FormBackground | An object containing the form's background appearance configuration. | type |
hideBranding | Whether monday.com branding is hidden. | |
layout FormLayout | An object containing the form's structure and presentation settings. | alignment |
logo FormLogo | An object containing the form's logo display configurations. | position |
primaryColor | The HEX color code of the primary theme color used in the form. | |
showProgressBar | Whether an indicator showing the form's completion progress bar is displayed. | |
submitButton FormSubmitButton | An object containing the form's submit button configurations. | text |
text FormText | An object containing the form's typography and text styling configurations. | color |
FormBackground
Configures the form’s background (e.g., color, image, or none).
Field | Description | Enum values |
|---|---|---|
type | The form's background type. |
|
value | The form's background value.
|
FormLayout
Defines the form's layout, alignment, and format.
Field | Description | Enum values |
|---|---|---|
alignment | The form's text and content alignment. |
|
direction | The form's reading direction. |
|
format | The form's display format. This can be a step-by-step form or a classic one-page form. |
|
FormLogo
Configures the form’s logo (e.g., placement, size, and image URL).
Field | Description | Enum values |
|---|---|---|
position | The form's logo placement. |
|
size | The form's logo size. |
|
url | The URL for the form's logo. |
FormSubmitButton
Defines the form's submit button text.
| Field | Description |
|---|---|
text String | The custom text displayed on the form's submit button. |
FormText
Defines the form's typography configuration.
Field | Description | Enum values |
|---|---|---|
color | The form's text HEX color code. | |
font | The form's font family. | |
size | The form's base text size. |
|
FormFeatures
An object containing form-level features like login requirements, response limits, and password protection.
Field | Description | Supported fields |
|---|---|---|
afterSubmissionView FormAfterSubmissionView | An object containing the form's post-submission configuration. | allowEditSubmission |
closeDate FormCloseDate | An object containing the form's automatic closure configuration. | date |
draftSubmission FormDraftSubmission | An object containing the form's draft saving configuration. | enabled |
isInternal | Whether the form is restricted to internal users only. | |
monday FormMonday | An object containing the board's settings for response handling. | includeNameQuestion |
password FormPassword | An object containing the form's password protection configuration. | enabled |
preSubmissionView FormPreSubmissionView | An object containing the form's welcome screen configuration. | description |
reCaptchaChallenge | Whether the form has reCAPTCHA verification enabled to prevent spam submissions. | |
requireLogin FormRequireLogin | An object containing the form's login requirement settings. | enabled |
responseLimit FormResponseLimit | An object containing the form's response limitation settings. | enabled |
shortenedLink FormShortenedLink | An object containing the form's shortened URL configuration. | enabled |
FormAfterSubmissionView
An object containing the form's post-submission settings.
Field | Description | Supported fields |
|---|---|---|
allowEditSubmission | Whether users can edit their responses after submission. | |
allowResubmit | Whether users can submit multiple responses to the same form. | |
allowViewSubmission | Whether users can view their answers after submission. | |
description | The text displayed after form submission. | |
redirectAfterSubmission FormRedirectAfterSubmission | An object containing the redirect configuration after form submission. | enabled |
showSuccessImage | Whether a success image appears after form submission. | |
title | The title text displayed after form submission. |
FormRedirectAfterSubmission
An object containing the form's post-submission redirect configuration.
| Field | Description |
|---|---|
enabled Boolean! | Whether responders are automatically redirected to a specified URL after form completion. |
redirectUrl String | The URL where users are redirected after successfully completing the form. |
FormCloseDate
An object containing the form's automatic closure configuration.
| Field | Description |
|---|---|
date String | The ISO 8601 timestamp when the form will automatically stop accepting responses. |
enabled Boolean! | Whether the form automatically closes at a specified date and time. |
FormDraftSubmission
An object containing the form's draft saving configuration.
| Field | Description |
|---|---|
enabled Boolean! | Whether users are allowed to save incomplete responses as drafts. |
FormMonday
An object containing the form's board settings for response handling.
| Field | Description |
|---|---|
includeNameQuestion Boolean! | Whether a name question is added to the form. Corresponds to the item name column on the board. |
includeUpdateQuestion Boolean! | Whether an update field is added to the form. Corresponds to the updates section of the associated item. |
itemGroupId String | The board group ID where new items will be created from form responses. |
syncQuestionAndColumnsTitles Boolean! | Whether the form question title syncs with the board column name. |
FormPassword
An object containing the form's password protection configuration.
| Field | Description |
|---|---|
enabled Boolean! | Whether users must enter a password to access the form. |
FormPreSubmissionView
An object containing the settings for the optional welcome screen shown before the form begins.
| Field | Description | Supported fields |
|---|---|---|
description String | The text displayed on the welcome screen (e.g., extra context, instructions). | |
enabled Boolean! | Whether a welcome screen is displayed before starting the form. | |
startButton FormStartButton | An object containing the form's welcome screen start button configuration. | text String |
title String | The title text displayed on the welcome screen. |
FormRequireLogin
An object containing the form's login requirement settings.
| Field | Description |
|---|---|
enabled Boolean! | Whether the form requires users to log in before submitting responses. |
redirectToLogin Boolean! | Whether unauthenticated users are automatically redirected to the login page. |
FormResponseLimit
An object containing the form's response limitation settings.
| Field | Description |
|---|---|
enabled Boolean! | Whether the form's response limits are enabled. |
limit Int | The maximum number of form responses allowed. |
FormShortenedLink
An object containing the form's shortened URL configuration.
| Field | Description |
|---|---|
enabled Boolean! | Whether shortened URLs can be generated. |
url String | The form's generated, shortened URL. Only available when shortened links are enabled. |
FormQuestion
An array of objects containing the form's question content, in display order.
Field | Description | Supported fields |
|---|---|---|
description | Optional text providing additional context, instructions, or examples for the question. | |
id | The question's unique identifier. | |
options [FormQuestionOption!] | The available options for choice-based questions. Each option defines a display label. | label |
required | Whether the question must be answered to submit the form. | |
settings FormQuestionSettings | An object containing question type-specific configurations. | checkedByDefault |
showIfRules | Conditional logic rules that determine whether the question is displayed, based on responses to other questions. | |
title | The question's title. Must be at least one character long. | |
type FormQuestionType | The question's type. Determines input behavior and validation. | |
visible | Whether the question is visible to responders. Hidden questions remain in the form structure but aren't displayed to responders. |
FormQuestionOption
An array containing the available options for choice-based questions.
| Field | Description |
|---|---|
label String! | The display text for individual option choices (in select-type questions). |
FormQuestionSettings
An object containing the form's question type-specific configuration. If a type-specific setting is provided (e.g., includeTime), the form must contain a question of that type, or the mutation won't work.
Field | Description | Enum values | Supported fields |
|---|---|---|---|
checkedByDefault | Whether the box should be checked by default. Only for boolean and checkbox questions. | ||
defaultCurrentDate | Whether the current date is set as the default value. Only for date questions. | ||
display | The display options for select-type questions. Only for single or multiple select questions. |
| |
includeTime | Whether the time selection (hours and minutes) is included with the date selector. If | ||
limit | The maximum rating value that can be selected. Only for rating questions. | ||
locationAutofilled | Whether the responder's location is automatically detected and filled. Uses the browser's geolocation services. Requires user permission. Only for location questions. | ||
optionsOrder | The ordering options for select questions. Only for single or multiple select questions. |
| |
prefill PrefillSettings | The configuration for automatically populating question values. | enabled | |
prefixAutofilled | Whether the phone country prefix is automatically detected and filled. Uses the responder's geographic location or browser settings. Only for phone questions. | ||
prefixPredefined PhonePrefixPredefined | The configuration for setting a predefined phone country prefix that will be pre-selected for responders. Only for phone questions. | enabled | |
skipValidation | Whether URL format validation is skipped, allowing any text input. Only for link/URL questions. |
PhonePrefixPredefined
Defines the configuration for pre-selecting a phone country prefix for responders.
| Field | Description |
|---|---|
enabled Boolean! | Whether a pre-defined phone country prefix is enabled for phone number questions. If true, the specified prefix will be pre-selected. |
prefix String | The predefined phone country prefix in capital letters (e.g., "US", "UK"). |
PrefillSettings
Defines the configuration for auto-populating question values.
Field | Description | Enum values |
|---|---|---|
enabled | Whether the question's prefill functionality is enabled. If | |
lookup | The field or parameter name to lookup from the prefill source. For | |
source | The sources for prefilling question values. |
|
FormQuestionType
Supported enum values for FormQuestionType.
| Boolean | ConnectedBoards | Country | Date | DateRange | File | |
| Link | Location | LongText | MultiSelect | Name | Number | People |
| Phone | Rating | ShortText | Signature | SingleSelect | Subitems | Updates |
FormTag
An array of tracking tags for categorization and analytics.
query {
form(formToken: "YOUR_FORM_TOKEN") {
tags {
id
name
value
columnId
}
}
}{
"data": {
"form": {
"tags": [
{
"id": "8f2a91c4-6d9a-49c3-bf12-93b4f019d7e1",
"columnId": "short_textxjwe48lm",
"value": "ENGLISH",
"name": "LANGUAGE"
}
]
}
},
"extensions": {
"request_id": "2d74c9f0-5b21-4e68-a123-8f91bb47e0cd"
}
}| Field | Description |
|---|---|
columnId String! | The unique identifier of the column the tag is associated with. |
id String! | The tag's unique identifier. |
name String! | The tag's name. |
value String | The tag's value. |
ResponseForm
An object containing the form's accessibility, appearance, features, questions, and tags.
Field | Description | Supported subfields |
|---|---|---|
accessibility FormAccessibility | The form's accessibility settings. | language |
active | Whether the form is visible and accepting responses. | |
appearance FormAppearance | The form's visual style settings. | background |
createWithAi | Whether the form was originally created with monday.com’s AI-assisted form builder. | |
description | The optional form description, displayed below the title. | |
features FormFeatures | The form's toggles and feature settings. | afterSubmissionView |
id | The form's unique board view identifier. | |
isAnonymous | Whether responses are collected anonymously. | |
ownerId | The user ID of the form's owner/creator. | |
questions [FormQuestion!] | An array of question objects that make up the form, in display order. | description |
tags [FormTag!] | Tracking tags for categorization and analytics. | columnId |
title | Title displayed at the top of the form. | |
token | The form's string-based unique token. Used in API queries and mutations. | |
type | The form's type. |
UpdateFormInput
An object defining the form's properties to update.
| Field | Description | Supported Fields |
|---|---|---|
description String | The form's updated description. | |
questions [QuestionOrderInput!] | An ordered array of all question IDs in the form. Must include every existing question ID, and their order determines the display order of the questions. | id String! |
title String | The form's updated title. Must be at least one character long. |
UpdateFormSettingsInput
An object defining the form settings inputs to update.
Field | Description | Supported Fields |
|---|---|---|
accessibility FormAccessibilityInput | The form's updated accessibility settings. | language |
appearance FormAppearanceInput | The form's updated visual style settings. | background |
features FormFeaturesInput | The form's updated toggles and feature settings. | afterSubmissionView |
FormAccessibilityInput
An object containing the updated input for the form's updated accessibility options.
| Field | Description |
|---|---|
language String | The language code for the form's localization and interface text (e.g., "es", "en", "fr"). |
logoAltText String | The form's logo image alternative text description. |
FormAppearanceInput
An object containing the updated input for the form’s overall visual appearance (e.g., background, layout, colors, typography).
Field | Description | Supported fields |
|---|---|---|
background FormBackgroundInput | An object containing the form's updated background appearance configuration input. | type |
hideBranding | Whether monday.com branding is hidden. | |
layout FormLayoutInput | An object containing the form's updated structure and presentation settings input. | alignment |
logo FormLogoInput | An object containing the form's updated logo display configuration input. | position |
primaryColor | The HEX color code of the primary theme color used in the form. | |
showProgressBar | Whether an indicator showing the form's updated completion progress bar is displayed. | |
submitButton FormSubmitButtonInput | An object containing the form's updated submit button configuration input. | text |
text FormTextInput | An object containing the form's updated typography and text styling configuration input. | color |
FormBackgroundInput
Configures the form’s updated background input (e.g., color, image, or none).
Field | Description | Enum values |
|---|---|---|
type | The form's background type. |
|
value | The form's background value.
|
FormLayoutInput
Defines the form's updated layout, alignment, and format input.
Field | Description | Enum values |
|---|---|---|
alignment | The form's text and content alignment. |
|
direction | The form's reading direction. |
|
format | The form's display format. This can be a step-by-step form or a classic one-page form. |
|
FormLogoInput
Configures the form’s updated logo input (e.g., placement, size, and image URL).
Field | Description | Enum values |
|---|---|---|
position | The form's logo placement. |
|
size | The form's logo size. |
|
FormSubmitButtonInput
Defines the form's updated submit button text.
| Field | Description |
|---|---|
text String | The custom text displayed on the form's submit button. |
FormTextInput
Defines the form's updated typography configuration.
Field | Description | Enum values |
|---|---|---|
color | The form's text HEX color code. | |
font | The form's font family. | |
size | The form's base text size. |
|
FormFeaturesInput
An object containing the input for form-level features like login requirements, response limits, and password protection.
Field | Description | Supported fields |
|---|---|---|
afterSubmissionView | An object containing the form's updated post-submission configuration input. | allowEditSubmission |
closeDate | An object containing the form's updated automatic closure configuration input. | date |
draftSubmission | An object containing the form's updated draft saving configuration input. | enabled |
monday | An object containing the updated board's settings input for response handling. | includeNameQuestion |
password | An object containing the form's updated password protection configuration input. | enabled |
preSubmissionView | An object containing the form's updated welcome screen configuration input. | description |
reCaptchaChallenge | Whether the form has reCAPTCHA verification enabled to prevent spam submissions. | |
requireLogin | An object containing the form's updated login requirement settings input. | enabled |
responseLimit | An object containing the form's updated response limitation settings input. | enabled |
FormAfterSubmissionViewInput
An object containing the form's updated post-submission settings.
Field | Description | Supported fields |
|---|---|---|
allowEditSubmission | Whether users can edit their responses after submission. | |
allowResubmit | Whether users can submit multiple responses to the same form. | |
allowViewSubmission | Whether users can view their answers after submission. | |
description | The text displayed after form submission. | |
redirectAfterSubmission | An object containing the redirect configuration after form submission. | enabled |
showSuccessImage | Whether a success image appears after form submission. | |
title | The title text displayed after form submission. |
FormRedirectAfterSubmissionInput
An object containing the form's updated post-submission redirect configuration input.
| Field | Description |
|---|---|
enabled Boolean | Whether responders are automatically redirected to a specified URL after form completion. |
redirectUrl String | The URL where users are redirected after successfully completing the form. |
FormCloseDateInput
An object containing the form's updated automatic closure configuration.
| Field | Description |
|---|---|
date String | The ISO 8601 timestamp when the form will automatically stop accepting responses. |
enabled Boolean | Whether the form automatically closes at a specified date and time. |
FormDraftSubmissionInput
An object containing the form's updated draft saving configuration input.
| Field | Description |
|---|---|
enabled Boolean | Whether users are allowed to save incomplete responses as drafts. |
FormMondayInput
An object containing the form's updated board settings input for response handling.
| Field | Description |
|---|---|
includeNameQuestion Boolean | Whether a name question is added to the form. Corresponds to the item name column on the board. |
includeUpdateQuestion Boolean | Whether an update field is added to the form. Corresponds to the updates section of the associated item. |
itemGroupId String | The board group ID where new items will be created from form responses. |
syncQuestionAndColumnsTitles Boolean | Whether the form question title syncs with the board column name. |
FormPasswordInput
An object containing the form's updated password protection configuration input.
| Field | Description |
|---|---|
enabled Boolean | Whether users must enter a password to access the form. This can only be used to disable password protection. To enable it, use the set_form_password mutation. |
FormPreSubmissionViewInput
An object containing the updated settings input for the optional welcome screen shown before the form begins.
| Field | Description | Supported fields |
|---|---|---|
description String | The text displayed on the welcome screen. | |
enabled Boolean | Whether a welcome screen is displayed before starting the form. | |
startButton FormStartButtonInput | An object containing the form's welcome screen start button configuration input. | text String |
title String | The title text displayed on the welcome screen. |
FormRequireLoginInput
An object containing the form's updated login requirement settings input.
| Field | Description |
|---|---|
enabled Boolean | Whether the form requires users to log in before submitting responses. |
redirectToLogin Boolean | Whether unauthenticated users are automatically redirected to the login page. |
FormResponseLimitInput
An object containing the form's updated response limitation settings input.
| Field | Description |
|---|---|
enabled Boolean | Whether the form's response limits are enabled. |
limit Int | The maximum number of form responses allowed. |
UpdateQuestionInput
An object containing the question's updated properties.
Field | Description | Supported Fields |
|---|---|---|
description | The question's updated description. | |
required | Whether the question must be answered to submit the form. | |
settings | The question's updated type-specific settings. | checkedByDefault |
title | The question's updated title. | |
type | The question's updated type that determines input behavior and validation. You can't pass a new question type—it must match the type of the existing question. | |
visible | Whether the question is visible to respondents. Hidden questions remain in the form structure but aren't displayed to respondents. |
FormQuestionSettingsInput
An object containing the question's updated type-specific configuration. If a type-specific setting is provided (e.g., includeTime), the form must contain a question of that type, or the mutation won't work.
Field | Description | Enum values | Supported fields |
|---|---|---|---|
checkedByDefault | Whether the box should be checked by default. Only for boolean and checkbox questions. | ||
defaultCurrentDate | Whether the current date is set as the default value. Only for date questions. | ||
display | The display options for select-type questions. Only for single or multiple select questions. |
| |
includeTime | Whether the time selection (hours and minutes) is included with the date selector. If | ||
locationAutofilled | Whether the responder's location is automatically detected and filled. Uses the browser's geolocation services. Requires user permission. Only for location questions. | ||
optionsOrder | The ordering options for select questions. Only for single or multiple select questions. |
| |
prefill | The configuration for automatically populating question values. | enabled | |
prefixAutofilled | Whether the phone country prefix is automatically detected and filled. Uses the responder's geographic location or browser settings. Only for phone questions. | ||
prefixPredefined | The configuration for setting a predefined phone country prefix that will be pre-selected for responders. Only for phone questions. | enabled | |
skipValidation | Whether URL format validation is skipped, allowing any text input. Only for link/URL questions. |
PhonePrefixPredefinedInput
Defines the configuration for pre-selecting a phone country prefix for responders.
| Field | Description |
|---|---|
enabled Boolean! | Whether a pre-defined phone country prefix is enabled for phone number questions. If true, the specified prefix will be pre-selected. |
prefix String | The predefined phone country prefix in capital letters (e.g., "US", "UK"). |
PrefillSettingsInput
Defines the configuration for auto-populating question values.
Field | Description | Enum values |
|---|---|---|
enabled | Whether the question's prefill functionality is enabled. If | |
lookup | The field or parameter name to look up from the prefill source. For | |
source | The sources for prefilling question values. |
|
