Form

Learn how to read monday.com Workforms via the platform API

monday.com Workforms enables you to create and share custom forms that automatically sync with your monday boards and workflows. You can fully control the form's settings, including questions, appearance, and accessibility settings.

Queries

You can retrieve monday.com form data via the API through the form query.

  • Returns metadata for a given form
  • Can only be queried at the root; cannot be nested within another query
  • You must have access to the board associated with the form to run this query
🚧 The `form` query is only available in API versions 2025-10 and later
query {
  form(formToken: "YOUR_FORM_TOKEN") {
    id
    title
    active
    appearance {
      primaryColor
      showProgressBar
    }
    features {
      responseLimit {
        enabled
        limit
      }
    }
    questions {
      id
      title
      type
      required
      visible
    }
  }
}
{
  "data": {
    "form": {
      "id": 12345,
      "title": "Customer Feedback Survey",
      "active": true,
      "appearance": {
        "primaryColor": "#2196f3",
        "showProgressBar": false
      },
      "features": {
        "responseLimit": {
          "enabled": true,
          "limit": 500
        }
      },
      "questions": [
        { "id": "q1", "title": "What is your full name?", "type": "Name", "required": true, "visible": true },
        { "id": "q2", "title": "What is your email address?", "type": "Email", "required": true, "visible": true },
        { "id": "q3", "title": "How would you rate your experience?", "type": "Rating", "required": false, "visible": true }
      ]
    }
  }
}

Arguments

You can use the following argument(s) to reduce the number of results returned in your form query.

ArgumentDescription
formToken String!The form's unique string token, located in the form's URL.

How to access the form's token

  1. Open your form and click Share form in the top-right corner.
  2. This opens a pop-up with your form's shareable URL.

Sample URL: https://forms.monday.com/forms/abc123def456ghi789?r=use1

  1. The token is the alphanumeric string that appears right after /forms/ and before the ?. In the sample above, the token is abc123def456ghi789.

Fields

You can use the following field(s) to specify what information your form query will return. Some fields will have their own subfields.

FieldDescriptionSupported subfields
accessibility FormAccessibilityThe form's accessibility settings. language String
logoAltText String
active Boolean!Whether the form is visible and accepting responses.
appearance FormAppearanceThe form's visual style settings. background FormBackground
hideBranding Boolean!
layout FormLayout
logo FormLogo
primaryColor String
showProgressBar Boolean!
submitButton FormSubmitButton
text FormText
createWithAi Boolean!Whether the form was originally created with monday.com’s AI-assisted form builder.
description StringThe optional form description, displayed below the title.
features FormFeaturesThe form's toggles and feature settings.afterSubmissionView FormAfterSubmissionView
closeDate FormCloseDate
draftSubmission FormDraftSubmission
isInternal Boolean!
monday FormMonday
password FormPassword
preSubmissionView FormPreSubmissionView
reCaptchaChallenge Boolean!
requireLogin FormRequireLogin
responseLimit FormResponseLimit
shortenedLink FormShortenedLink
id Int!The form's unique board view identifier.
isAnonymous Boolean!Whether responses are collected anonymously.
isSuspicious Boolean!Whether the form has been flagged for suspicious content or activity.
ownerId IntThe user ID of the form's owner/creator.
questions [FormQuestion!]An array of question objects that make up the form, in display order.description String
id String!
options [FormQuestionOption!]
required Boolean!
settings FormQuestionSettings
showIfRules JSON
title String!
type FormQuestionType
visible Boolean!
tags [FormTag!]Tracking tags for categorization and analytics. columnId String!
id String!
name String!
value String
title String!Title displayed at the top of the form.
token String!The form's string-based unique token. Used in API queries and mutations.
type StringThe form's type.