Get Form Overview

GET/v1/forms/{form_id}/overview

Returns public information about a form.

This endpoint does not require authentication.

Path Parameters

form_id*string

Response Body

application/json

application/json

fetch("https://example.com/v1/forms/string/overview", {  method: "GET"})
{
  "status": "open",
  "schema": null,
  "show_branding": true,
  "redirect_url": null,
  "success_title": "string",
  "success_message": "string"
}
{
  "message": "string"
}

Duplicate Form POST

Duplicates an existing form, copying its configuration. The following properties get copied to the duplicated form: - name - is_enabled - limit - honeypot_field - emails - redirect_url - success_title - success_message - schema

Create Submission POST

Submits data to a form. View [examples](/examples). ### Request Formats This endpoint accepts submissions in two formats: - **application/json** - **multipart/form-data** #### Special Handling for multipart/form-data - If a field named `$` is present, all other non-file fields are ignored. - If `$` contains a valid stringified JSON object, it will be parsed and used as the submission data. - If `$` contains any other value, it will be ignored. ### Common Errors We have separated common errors to `422` (`303` if you are using `Accept: text/html`) response to help you better handle them. Here is a breakdown of all common error codes: | Code | Description | | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | file_storage_limit_reached | Your team has reached its file storage limit. | | form_disabled | The form is currently disabled. You can enable or disable the form in the dashboard or by using this [endpoint](/http-api/forms/update-form). | | no_data | No data was submitted. | | rate_limit | The rate limit has been exceeded. Please wait at least 10 seconds before submitting another form from the same IP address. | | submission_limit_reached | Configured form `limit` has been reached or your team has reached the total submission limit counted across all forms it owns. | | validation_error | The submission did not pass validation. (Reserved for future use.) |