Get Forms in Current Group
Endpoint: GET /forms
Authentication: Required
Description: Retrieves all forms in the group which maps to the API key.
Parameters
None
Sample Request
curl -u "your_app_id:your_api_key" \ -H "Content-Type: application/json" \ "https://your-domain.com/api/v1/forms"
Sample Response
[
{
"form_id": "d0ef0fc9-f9a9-4dda-a2c2-17e949f58f7f",
"name": "Contact Us",
"description": "Contact Us",
"controls": [
{
"control_id": "34832679-c1bc-491d-ad6a-8ff2b36759db",
"label": "First name",
"description": "",
"control_type": "textbox",
"required": true,
"isNumber": false,
"isEmail": false,
"isRespondent": false,
"isHidden": false,
"isAutoPopulated": false
},
{
"control_id": "15b38c4b-f2e3-408f-ad50-913a346bb573",
"label": "Surname",
"description": "",
"control_type": "textbox",
"required": true,
"isNumber": false,
"isEmail": false,
"isRespondent": false,
"isHidden": false,
"isAutoPopulated": false
},
{
"control_id": "4a6ba8a7-53a3-401c-bc27-481e5b50562f",
"label": "Email",
"description": "",
"control_type": "textbox",
"required": false,
"isNumber": false,
"isEmail": true,
"isRespondent": true,
"isHidden": false,
"isAutoPopulated": false
},
{
"control_id": "c8a5ed15-ed4f-4ab9-9f02-bbc30d553573",
"label": "My request relates to...",
"description": "",
"control_type": "combobox",
"required": true,
"isNumber": false,
"isEmail": false,
"isRespondent": false,
"isHidden": false,
"isAutoPopulated": false
},
{
"control_id": "f2b84a95-aa15-4517-a395-f3833ca53593",
"label": "Please give us more information",
"description": "",
"control_type": "textarea",
"required": false,
"isNumber": false,
"isEmail": false,
"isRespondent": false,
"isHidden": false,
"isAutoPopulated": false
}
]
}
]Response Codes
- 200: Success - Returns array of forms
- 400: Invalid Input
- 401: Access Denied
- 404: Not Found