Using The FormWise API

The Data API lets send form responses from third party form builders that can be executed using your form, as if it was filled out traditionally on FormWise.

https://youtu.be/Oik6e7creA8?si=Y9_PrekiI3R4DGZXyoutu.be

Form Completion

POST a Form Completion to Formwise

Post a form completion

post

Sending a form to this endpoint will process as it would a traditional Formwise form submission.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

form_idstringRequired

The Live Form ID of the Form you are processing the responses with.

answer_arraystring[]Required

An array of answers which represent the form response. Ensure the order of the answers matches the order of the questions on your form.

Responses

200

OK: Returns the Response ID of the submitted form.

application/json

Response_IDstringOptionalExample: 1689116584424x9912552851101456000

400

Bad Request: See Errors Below

post

/wf/form_completion

HTTPcURLJavaScriptPython

POST /api/1.1/wf/form_completion HTTP/1.1
Host: app.formwise.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "form_id": "text",
  "answer_array": [
    "text"
  ]
}

{
  "Response_ID": "1689116584424x9912552851101456000"
}

Headers

Name	Type	Description
Authorization*	Bearer <YOUR-KEY>	Your API Token which can be found on the Account page

Request Body

Name	Type	Description
form_id*	"1679493702554x213757137604050940"	The Live Form ID of the Form you are processing the responses with.
answer_array*	["Yes","No","Maybe","Certainly","Unsure"]	An array of answers which represent the form response. Ensure the order of the answers matches the order of the questions on your form. Example: ["Yes","No","Maybe","Certainly","Unsure"]

200: OK Returns the Response ID of the response if successfully created.

400: Bad Request See Errors Below

After a successful POST, you will see the form response within your Live form responses. You will also receive your own email which is used to reference the account when using Zapier.

Example Response

{
    "Response ID": "1689116584424x991255285110145000"
}

Retrieve Response

Retrieve Response request is used when you want to retrieve the results of a form submission.

GET a Response Result from Formwise

GET https://app.formwise.ai/api/1.1/wf/retrieve_response/ID=<response id>

Making this GET request will request the results of a response. The Formwise API is async so we recommend waiting for the content to generate before initiating this API call as you will receive an error otherwise.

Path Parameters

Name	Type	Description
ID*	Object	The ID of the response returned from the Form Completion API call. Ensure there are no quotes around the ID.

Headers

Name	Type	Description
Authorization*	Bearer <YOUR-KEY>	Your API Token which can be found on the Account page

200: OK Returns the response along with all generated content.

Retrieve Form IDs

The Retrieve Form IDs request is used when you want to retrieve a list of your Form IDs for use in subsequent API calls. This API is not entirely required as you can always copy the Form ID from the URL once you share your Live form within your Dashboard or on the Form Builder.

GET all Form IDs

GET https://app.formwise.ai/api/1.1/wf/form_retrieval

This operation will retrieve your Live forms in pagination (25 at once) form.

Headers

Name	Type	Description
Authorization*	Bearer <YOUR-KEY>	Your API Token which can be found on the Account page

200: OK Returns list of Live Forms available for use.

After a successful GET, you will receive an array of your Live Forms along with their ID which is necessary for a Form Completion, along with its Title in the event you want to store this ID and want to reference it later.

Example Response

[ 
  {
    "_id": "1679493702554x213757137604050940",
    "title": "Marketing Feedback Form"
    },
  {
    "_id": "1679493702554x994703839005245400",
    "title": "Facebook Ad Generator"
    }
]

Errors

The Data API runs on certain conditions which may throw errors when you try to Upload form data or Retrieve information about your forms. The most common error will be a 400 Error. There a few things this could mean and ways to remedy them.

• Your Monthly Quota has been exceeded and you cannot process any additional Form Responses.

  • Upgrade your account to a higher tiered plan.

• You are using a Preview Form ID when it should be a Live Form ID.

  • Use the Retrieve Form ID GET request and select a Form or Share a form on your dashboard and copy the ID from the URL.

• Your Account is Locked due to a subscription cancellation.

  • Update your account standing by navigating to the home page and updating your payment settings.

Not returning a Response but no error

If you are not receiving a response upon Form submission, it is possible that the form ID you provided was not created by the user whose account Token is associated with the API call. If you are a collaborator, we recommend using the Token of the Parent account of your organization.