Skip to content

Controls who can view and submit the form. The state field sets the overall visibility, while privateSettings restricts access to specific users.

Schema

FieldTypeDescription
statestringVisibility: "public", "unlisted", or "private"
isEnabledbooleanWhether the form accepts new submissions
isUserInaccessiblebooleanWhether the form owner has restricted access
privateSettings.allowedUsersstring[]User IDs allowed to access a private form
supportedLanguagesstring[]Language codes the form supports
urlstringCustom URL slug for the form

State values:

  • public: Listed and accessible to anyone with the link
  • unlisted: Accessible via direct link but not listed publicly
  • private: Restricted to users in privateSettings.allowedUsers
{
  "state": "unlisted",
  "isEnabled": true,
  "isUserInaccessible": true,
  "privateSettings": {
    "allowedUsers": []
  },
  "supportedLanguages": [],
  "url": "example-form"
}