Other types

Learn more about the other types used when reading forms via the API

🚧 The following queries are only available in API versions 2025-10 and later

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
FieldDescription
language StringThe language code for the form's localization and interface text (e.g., "es", "en", "fr").
logoAltText StringThe 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
FieldDescriptionSupported fields
background FormBackgroundAn object containing the form's background appearance configuration. type FormBackgrounds
value String
hideBranding Boolean!Whether monday.com branding is hidden.
layout FormLayoutAn object containing the form's structure and presentation settings. alignment FormAlignment
direction FormDirection
format FormFormat
logo FormLogoAn object containing the form's logo display configurations. position FormLogoPosition
size FormLogoSize
url String
primaryColor StringThe 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 FormSubmitButtonAn object containing the form's submit button configurations. text String
text FormTextAn 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).

FieldDescriptionEnum values
type FormBackgroundsThe form's background type. Color
Image
None
value StringThe form's background value.
  • For Color, it's a HEX color code.
  • For Image, it's the image's URL.
  • FormLayout

    Defines the form's layout, alignment, and format.

    FieldDescriptionEnum values
    alignment FormAlignmentThe form's text and content alignment.Center
    FullLeft
    FullRight
    Left
    Right
    direction FormDirectionThe form's reading direction.LtR
    Rtl
    format FormFormatThe 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).

    FieldDescriptionEnum values
    position FormLogoPositionThe form's logo placement.Auto
    Center
    Left
    Right
    size FormLogoSizeThe form's logo size.ExtraLarge (96px height)
    Large (72px height)
    Medium (40px height)
    Small (32px height)
    url StringThe URL for the form's logo.

    FormSubmitButton

    Defines the form's submit button text.

    FieldDescription
    text StringThe custom text displayed on the form's submit button.

    FormText

    Defines the form's typography configuration.

    FieldDescriptionEnum values
    color StringThe form's text HEX color code.
    font StringThe form's font family.
    size FormFontSizeThe 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
    FieldDescriptionSupported fields
    afterSubmissionView FormAfterSubmissionViewAn object containing the form's post-submission configuration.allowEditSubmission Boolean!
    allowResubmit Boolean!
    allowViewSubmission Boolean!
    description String
    redirectAfterSubmission FormRedirectAfterSubmission
    showSuccessImage Boolean!
    title String
    closeDate FormCloseDateAn object containing the form's automatic closure configuration. date String
    enabled Boolean!
    draftSubmission FormDraftSubmissionAn object containing the form's draft saving configuration. enabled Boolean!
    isInternal Boolean!Whether the form is restricted to internal users only.
    monday FormMondayAn object containing the board's settings for response handling. includeNameQuestion Boolean!
    includeUpdateQuestion Boolean!
    itemGroupId String
    syncQuestionAndColumnsTitles Boolean!
    password FormPasswordAn object containing the form's password protection configuration.enabled Boolean!
    preSubmissionView FormPreSubmissionViewAn 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 FormRequireLoginAn object containing the form's login requirement settings. enabled Boolean!
    redirectToLogin Boolean!
    responseLimit FormResponseLimitAn object containing the form's response limitation settings.enabled Boolean!
    limit Int
    shortenedLink FormShortenedLinkAn object containing the form's shortened URL configuration.enabled Boolean!
    url String

    FormAfterSubmissionView

    An object containing the form's post-submission settings.

    FieldDescriptionSupported 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 StringThe text displayed after form submission.
    redirectAfterSubmission FormRedirectAfterSubmissionAn object containing the redirect configuration after form submission.enabled Boolean!
    redirectUrl String
    showSuccessImage Boolean!Whether a success image appears after form submission.
    title StringThe title text displayed after form submission.

    FormRedirectAfterSubmission

    An object containing the form's post-submission redirect configuration.

    FieldDescription
    enabled Boolean!Whether responders are automatically redirected to a specified URL after form completion.
    redirectUrl StringThe URL where users are redirected after successfully completing the form.

    FormCloseDate

    An object containing the form's automatic closure configuration.

    FieldDescription
    date StringThe 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.

    FieldDescription
    enabled Boolean!Whether users are allowed to save incomplete responses as drafts.

    FormMonday

    An object containing the form's board settings for response handling.

    FieldDescription
    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 StringThe 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.

    FieldDescription
    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.

    FieldDescriptionSupported fields
    description StringThe text displayed on the welcome screen (e.g., extra context, instructions).
    enabled Boolean!Whether a welcome screen is displayed before starting the form.
    startButton FormStartButtonAn object containing the form's welcome screen start button configuration.text String
    title StringThe title text displayed on the welcome screen.

    FormRequireLogin

    An object containing the form's login requirement settings.

    FieldDescription
    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.

    FieldDescription
    enabled Boolean!Whether the form's response limits are enabled.
    limit IntThe maximum number of form responses allowed.

    FormShortenedLink

    An object containing the form's shortened URL configuration.

    FieldDescription
    enabled Boolean!Whether shortened URLs can be generated.
    url StringThe 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
    FieldDescriptionEnum valuesSupported fields
    description StringOptional 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 FormQuestionSettingsAn 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 JSONConditional 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 FormQuestionTypeThe 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.

    FieldDescription
    label String!The display text for individual option choices (in select-type questions).

    FormQuestionSettings

    An object containing the form's question type-specific configuration.

    FieldDescriptionEnum valuesSupported fields
    checkedByDefault BooleanWhether the box should be checked by default. Only for boolean and checkbox questions.
    defaultCurrentDate BooleanWhether the current date is set as the default value. Only for date questions.
    display FormQuestionSelectDisplayThe display options for select-type questions. Only for single or multiple select questions.Dropdown
    Horizontal
    Vertical
    includeTime BooleanWhether the time selection (hours and minutes) is included with the date selector. If false, only the date is included. Only for date questions.
    labelLimitCount IntThe maximum number of options a user can select. Only for multiple select questions.
    limit IntThe maximum rating value that can be selected. Only for rating questions.
    locationAutofilled BooleanWhether the responder's location is automatically detected and filled. Uses the browser's geolocation services. Requires user permission. Only for location questions.
    optionsOrder FormQuestionSelectOrderByOptionsThe ordering options for select questions. Only for single or multiple select questions.Alphabetical
    Custom
    Random
    prefill PrefillSettingsThe configuration for automatically populating question values.enabled Boolean!
    lookup String!
    source FormQuestionPrefillSources
    prefixAutofilled BooleanWhether the phone country prefix is automatically detected and filled. Uses the responder's geographic location or browser settings. Only for phone questions.
    prefixPredefined PhonePrefixPredefinedThe configuration for setting a predefined phone country prefix that will be pre-selected for responders. Only for phone questions.enabled Boolean!
    prefix String
    skipValidation BooleanWhether 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.

    FieldDescription
    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 StringThe predefined phone country prefix in capital letters (e.g., "US", "UK").

    PrefillSettings

    Defines the configuration for auto-populating question values.

    FieldDescriptionEnum 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 FormQuestionPrefillSourcesThe 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
    FieldDescription
    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 StringThe tag's value.