Overview
Endpoints
List all forms GET forms/list
Lists all of your forms, including their field data and a summary of stats.
Example request:
curl -X GET https://www.magickit.io/api/forms/list -H "Authorization: X-MAGICKIT-TOKEN {key}"Example response:
[{
"id": "344f-1329-6eba-3bbd-c452",
"title": "Welcome to my Magic Shop",
"description": "My shop sells magic trinkets and tricks. Come wow your friends and family. ",
"acceptingResponses": "1",
"primaryColor": "#212529",
"coverImage": "https:\/\/www.magickit.io\/assets\/cdn\/forms\/cover.png",
"iconImage": "https:\/\/www.magickit.io\/assets\/cdn\/forms\/icon.png",
"fields": [{
"id": "61811a-3571-066b-ef40-acbe",
"title": "Question with Short answer",
"type": "Text box"
}, {
"id": "61895b-ffbb-3f2d-1bc2-6365",
"title": "Question with Paragraph answer",
"type": "Input box"
}{
"id": "614164-061a-e00a-458f-ebee",
"title": "Question with Multiple choice grid",
"type": "Multiple Choice Grid"
}],
"stats": {
"views": 20,
"responses": 10,
"responseRatePercentage": 50
}
}, {
"id": "2655-e611-d857-d970-efd5",
"title": "Get early access to future MagicKit tools",
"description": null,
"acceptingResponses": "1",
"primaryColor": "#212529",
"coverImage": null,
"iconImage": null,
"fields": [{
"id": "5972f8-7a70-4d53-aa7f-4bb1",
"title": "Email address",
"type": "Text box"
}],
"stats": {
"views": 0,
"responses": 0,
"responseRate": 0
}
}]
Responses GET forms/responses/{id}
Lists all responses for a specified form.
Example request:
curl -X GET https://www.magickit.io/api/forms/responses/{id} -H "Authorization: X-MAGICKIT-TOKEN {key}"Example response:
[{
"id": 4,
"dateTime": "2024-08-29 21:45:35",
"fieldResponses": [{
"field": {
"id": "572f39-72f8-d65c-4803-8f31",
"title": "Email address",
"type": "Text box"
},
"submittedValue": "jimmy@magickit.io"
}]
}]