Learn more about the other types used when reading 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 and can be queried as subfields on the form
query.
FormAccessibility
An object containing the form's accessibility options.
query {
form(formToken: "YOUR_FORM_TOKEN") {
accessibility {
language
logoAltText
}
}
}
{
"data": {
"form": {
"accessibility": {
"language": "en",
"logoAltText": "The company's logo."
}
}
},
"extensions": {
"request_id": "e48c2f1d-2b6e-4d7f-91b2-0c7d39f14a2f"
}
}
FormAccessibility Fields
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).
FormAppearance Fields
Field | Description | Supported fields |
---|---|---|
background FormBackground | An object containing the form's background appearance configuration. | type FormBackgrounds value String |
hideBranding Boolean! | Whether monday.com branding is hidden. | |
layout FormLayout | An object containing the form's structure and presentation settings. | alignment FormAlignment direction FormDirection format FormFormat |
logo FormLogo | An object containing the form's logo display configurations. | position FormLogoPosition size FormLogoSize url String |
primaryColor String | The HEX color code of the primary theme color used in the form. | |
showProgressBar Boolean! | Whether an indicator showing the form's completion progress bar is displayed. | |
submitButton FormSubmitButton | An object containing the form's submit button configurations. | text String |
text FormText | An object containing the form's typography and text styling configurations. | color String font String size FormFontSize |
FormBackground
Configures the form’s background (e.g., color, image, or none).
Field | Description | Enum values |
---|---|---|
type FormBackgrounds | The form's background type. | Color Image None |
value String | The form's background value. Color , it's a HEX color code.Image , it's the image's URL. |
FormLayout
Defines the form's layout, alignment, and format.
Field | Description | Enum values |
---|---|---|
alignment FormAlignment | The form's text and content alignment. | Center FullLeft FullRight Left Right |
direction FormDirection | The form's reading direction. | LtR Rtl |
format FormFormat | The form's display format. This can be a step-by-step form or a classic one-page form. | Classic OneByOne |
FormLogo
Configures the form’s logo (e.g., placement, size, and image URL).
Field | Description | Enum values |
---|---|---|
position FormLogoPosition | The form's logo placement. | Auto Center Left Right |
size FormLogoSize | The form's logo size. | ExtraLarge (96px height)Large (72px height)Medium (40px height)Small (32px height) |
url String | 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 String | The form's text HEX color code. | |
font String | The form's font family. | |
size FormFontSize | The form's base text size. | Large Medium Small |
FormFeatures
An object containing form-level features like login requirements, response limits, and password protection.
FormFeatures Fields
Field | Description | Supported fields |
---|---|---|
afterSubmissionView FormAfterSubmissionView | An object containing the form's post-submission configuration. | allowEditSubmission Boolean! allowResubmit Boolean! allowViewSubmission Boolean! description String redirectAfterSubmission FormRedirectAfterSubmission showSuccessImage Boolean! title String |
closeDate FormCloseDate | An object containing the form's automatic closure configuration. | date String enabled Boolean! |
draftSubmission FormDraftSubmission | An object containing the form's draft saving configuration. | enabled Boolean! |
isInternal Boolean! | Whether the form is restricted to internal users only. | |
monday FormMonday | An object containing the board's settings for response handling. | includeNameQuestion Boolean! includeUpdateQuestion Boolean! itemGroupId String syncQuestionAndColumnsTitles Boolean! |
password FormPassword | An object containing the form's password protection configuration. | enabled Boolean! |
preSubmissionView FormPreSubmissionView | An object containing the form's welcome screen configuration. | description String enabled Boolean! startButton FormStartButton title String |
reCaptchaChallenge Boolean! | Whether the form has reCAPTCHA verification enabled to prevent spam submissions. | |
requireLogin FormRequireLogin | An object containing the form's login requirement settings. | enabled Boolean! redirectToLogin Boolean! |
responseLimit FormResponseLimit | An object containing the form's response limitation settings. | enabled Boolean! limit Int |
shortenedLink FormShortenedLink | An object containing the form's shortened URL configuration. | enabled Boolean! url String |
FormAfterSubmissionView
An object containing the form's post-submission settings.
Field | Description | Supported fields |
---|---|---|
allowEditSubmission Boolean! | Whether users can edit their responses after submission. | |
allowResubmit Boolean! | Whether users can submit multiple responses to the same form. | |
allowViewSubmission Boolean! | Whether users can view their answers after submission. | |
description String | The text displayed after form submission. | |
redirectAfterSubmission FormRedirectAfterSubmission | An object containing the redirect configuration after form submission. | enabled Boolean! redirectUrl String |
showSuccessImage Boolean! | Whether a success image appears after form submission. | |
title String | 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.
FormQuestion Fields
Field | Description | Enum values | Supported fields |
---|---|---|---|
description String | Optional text providing additional context, instructions, or examples for the question. | ||
id String! | The question's unique identifier. | ||
options [FormQuestionOption!] | The available options for choice-based questions. Each option defines a display label. | label String! | |
required Boolean! | Whether the question must be answered to submit the form. | ||
settings FormQuestionSettings | An object containing question type-specific configurations. | checkedByDefault Boolean defaultCurrentDate Boolean display FormQuestionSelectDisplay includeTime Boolean labelLimitCount Int limit Int locationAutofilled Boolean optionsOrder FormQuestionSelectOrderByOptions prefill PrefillSettings prefixAutofilled Boolean prefixPredefined PhonePrefixPredefined skipValidation Boolean | |
showIfRules JSON | Conditional logic rules that determine whether the question is displayed, based on responses to other questions. | ||
title String! | The question's title. Must be at least one character long. | ||
type FormQuestionType | The question's type. Determines input behavior and validation. | Boolean , ConnectedBoards , Country , Date , DateRange , Email , File , Link , Location , LongText , MultiSelect , Name , Number , People , Phone , Rating , ShortText , Signature , SingleSelect , Subitems , Updates | |
visible Boolean! | Whether the question is visible to respondents. Hidden questions remain in the form structure but aren't displayed to respondents. |
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.
Field | Description | Enum values | Supported fields |
---|---|---|---|
checkedByDefault Boolean | Whether the box should be checked by default. Only for boolean and checkbox questions. | ||
defaultCurrentDate Boolean | Whether the current date is set as the default value. Only for date questions. | ||
display FormQuestionSelectDisplay | The display options for select-type questions. Only for single or multiple select questions. | Dropdown Horizontal Vertical | |
includeTime Boolean | Whether the time selection (hours and minutes) is included with the date selector. If false , only the date is included. Only for date questions. | ||
labelLimitCount Int | The maximum number of options a user can select. Only for multiple select questions. | ||
limit Int | The maximum rating value that can be selected. Only for rating questions. | ||
locationAutofilled Boolean | Whether the responder's location is automatically detected and filled. Uses the browser's geolocation services. Requires user permission. Only for location questions. | ||
optionsOrder FormQuestionSelectOrderByOptions | The ordering options for select questions. Only for single or multiple select questions. | Alphabetical Custom Random | |
prefill PrefillSettings | The configuration for automatically populating question values. | enabled Boolean! lookup String! source FormQuestionPrefillSources | |
prefixAutofilled Boolean | 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 Boolean! prefix String | |
skipValidation Boolean | 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 Boolean! | Whether the question's prefill functionality is enabled. If true , the values will be auto-populated from the specified source. | |
lookup String! | The field or parameter name to lookup from the prefill source. For Account sources, this is a user property like name or email. For QueryParam sources, this is the parameter name that's set in the URL. | |
source FormQuestionPrefillSources | The sources for prefilling question values. | Account QueryParam |
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"
}
}
FormTag Fields
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. |