Form Builder Inquiries API - Form API Documentation

Form Builder Inquiries

With the Form Builder Inquiries API, you can manage and track all your users’ inquiries in the Form Builder feature. You can use this API for the smooth tracking of all your leads.  

You can refer to the sample code provided on the right side of the screen and switch to your preferred language.

Form Builder Inquiries API returns all the inquiry details for the specified appId and pageId. To access this endpoint, login/signup to Appy Pie Developer account and obtain the required Access Token Key from the Authentication section. 

Below is the request URL and the Method is POST:

POST https://api.appexecutable.com/V4/webservices/FormBuilderApi.php

Parameter NameRequiredParameter TypeParameter Description
methodYesStringMethod formBuilderInquiries is pre-defined.
appIdYesStringApplication ID identifies a specific application on Appy Pie’s platform. You can obtain appID/BID from Appy Pie’s backend.
pageIdYesStringpageId is unique for every feature in the app. To obtain the pageId access the App Features API endpoint and you will get the Page ID for the respective feature in the response. For example: the pageId for the Formbuilder feature will look like formbuilder_1476352108292_49
Required Parameters are mandatory to access the API endpoint.

Errors

This error section displays all the errors with details.

Following are the error codes that indicate the success or failure of an API request:

Error CodeMeaning
400Bad Request -- Your request is invalid.
401Unauthorized -- Your API key is wrong.
403Forbidden -- The method requested is hidden for administrators only.
404Not Found -- The specified method could not be found.
405Method Not Allowed -- You tried to access a method with an invalid method.
406Not Acceptable -- You requested a format that is not json.
410Gone -- Request has been removed from our servers.
429Too Many Requests
500Internal Server Error -- We had a problem with our server. Try again later.
503Service Unavailable -- We are temporarily offline for maintenance. Please try again later.
To authorize, use this code:

1wget --no-check-certificate --quiet \
2	--method POST \
3	--timeout=0 \
4	--header "ACCESSTOKEN: Access Token Key" \
5	--header "Content-Type: application/json" \
6	--body-data
7	'{
8		"method": "formBuilderInquiries",
9		"appId": "12ef551d9385",
10		"pageId": "formbuilder_1476352108292_49"
11	 }' \
12	"https://api.appexecutable.com/V4/webservices/FormBuilderApi.php"

RESPONSE

{
  "data": [
    {
      "_id": "5a8ed1808b03be00563779bb",
      "appId": "c0e1917b075c",
      "pageId": "formbuilder_1577104715339_49",
      "requestId": "REQ#1",
      "subject": "Inquiry",
      "requestPage": "formbuilder",
      "formName": "4",
      "formData": [
        [
          "Testing",
          "testing@mailinator.com",
          "Male",
          "99xxxxxx99"
        ],
        [
          "Name",
          "Email",
          "Gender",
          "Phone"
        ],
        [
          "name",
          "email",
          "gender",
          "phone"
        ]
      ],
      "formbuilderData": "[{\"fieldName\":\"name\",\"fieldIdentifire\":\"name\",\"fieldLabel\":\"Name\",\"fieldValue\":\"Testing\"},{\"fieldName\":\"email\",\"fieldIdentifire\":\"email\",\"fieldLabel\":\"Email\",\"fieldValue\":\"testing@mailinator.com\"},{\"fieldName\":\"gender\",\"fieldIdentifire\":\"gender\",\"fieldLabel\":\"Gender\",\"fieldValue\":\"Male\"},{\"fieldName\":\"phone\",\"fieldIdentifire\":\"phone\",\"fieldLabel\":\"Phone\",\"fieldValue\":\"99xxxxxx99\"}]",
      "paymentStatus": "free",
      "mailStatus": 1,
      "status": 0,
      "readStatus": 1,
      "addedon": 1519309184,
      "updatedon": 1519382951
    }
  ],
  "status": "success",
  "msg": "Form Builder Inquiries Fetched Successfully."
}