{"info":{"_postman_id":"ee592a8d-476f-41d8-90d0-1582457aee67","name":"Hyperforms API","description":"

The Hyperforms API makes it easy for you to integrate our advanced form endpoints into your workflow or existing apps. Signup, grab yourself an API key and get building.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18074323","collectionId":"ee592a8d-476f-41d8-90d0-1582457aee67","publishedId":"UVByJqM4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1C2227","highlight":"E57432"},"publishDate":"2021-11-01T10:42:29.000Z"},"item":[{"name":"forms","item":[{"name":"Get all Forms and Settings in account","id":"67419631-3dfd-4e30-8b1d-5a6def538a58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.hyperforms.app/api/forms","description":"

List all forms associated with your account.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ee592a8d-476f-41d8-90d0-1582457aee67","id":"ee592a8d-476f-41d8-90d0-1582457aee67","name":"Hyperforms API","type":"collection"}},"urlObject":{"path":["forms"],"host":["https://my.hyperforms.app/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"67419631-3dfd-4e30-8b1d-5a6def538a58"},{"name":"Get Form Settings","id":"a311f6ab-647e-45cb-a4fa-bf0cbd82baf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.hyperforms.app/api/forms/:id","description":"

Get form settings.

(required) Form Endpoint URL Key

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"a311f6ab-647e-45cb-a4fa-bf0cbd82baf0"},{"name":"Update Form Settings","id":"d62029fa-1aeb-47b2-96f4-cc2707f436d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://my.hyperforms.app/api/forms/:id?name=&redirect_url=&enabled=&use_captcha=&use_autoresponder=&use_facebook_conversion=&use_form_to_sms=","description":"

Update the settings for a particular form.

Name given to the form endpoint.

\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"

URL / Thank You page to redirect to after a form is submitted.

\n","type":"text/plain"},"key":"redirect_url","value":""},{"description":{"content":"

Enable / Disable the form endpoint.

\n","type":"text/plain"},"key":"enabled","value":""},{"description":{"content":"

Enable / Disable reCAPTCHA on the form.

\n","type":"text/plain"},"key":"use_captcha","value":""},{"description":{"content":"

Enable / Disable Email Autoresponders on the form endpoint.

\n","type":"text/plain"},"key":"use_autoresponder","value":""},{"description":{"content":"

Enable / Disable Use of Facebook Conversion API.

\n","type":"text/plain"},"key":"use_facebook_conversion","value":""},{"description":{"content":"

Enable / Disable use of Form to SMS.

\n","type":"text/plain"},"key":"use_form_to_sms","value":""}],"variable":[{"description":{"content":"

(required) Form Endpoint URL Key

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"d62029fa-1aeb-47b2-96f4-cc2707f436d3"},{"name":"Delete Form from account","id":"a8de2563-95fd-45f6-b8f3-5c225cbad9bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://my.hyperforms.app/api/forms/:id","description":"

Delete a form and all data associated with it. This is permanent.

(required) Form Endpoint URL Key

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"a8de2563-95fd-45f6-b8f3-5c225cbad9bf"},{"name":"Add New Form to account","id":"ed7b3121-9ddb-4b27-ac23-de44d9ca980f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://my.hyperforms.app/api/forms?name=¬ification_email=&redirect_url=","description":"

Create a new form endpoint.

(required) Name you want to give the form endpoint.

\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"

(required) Email address you want to receive form submissions.

\n","type":"text/plain"},"key":"notification_email","value":""},{"description":{"content":"

Redirection / Thank You page to use after a form has been submitted.

\n","type":"text/plain"},"key":"redirect_url","value":""}],"variable":[]}},"response":[],"_postman_id":"ed7b3121-9ddb-4b27-ac23-de44d9ca980f"}],"id":"a8174332-185f-4761-a5bb-8c202e829720","description":"

The forms endpoint allows you to control all aspects of updating/creating and deleting your form endpoints.

\n","_postman_id":"a8174332-185f-4761-a5bb-8c202e829720","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ee592a8d-476f-41d8-90d0-1582457aee67","id":"ee592a8d-476f-41d8-90d0-1582457aee67","name":"Hyperforms API","type":"collection"}}},{"name":"submissions","item":[{"name":"Get List all form submissions","id":"9d65e6c4-0a1c-42e3-a81a-10f0ae7e9b5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.hyperforms.app/api/submissions","description":"

Get all submissions from all of your form endpoints.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ee592a8d-476f-41d8-90d0-1582457aee67","id":"ee592a8d-476f-41d8-90d0-1582457aee67","name":"Hyperforms API","type":"collection"}},"urlObject":{"path":["submissions"],"host":["https://my.hyperforms.app/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d65e6c4-0a1c-42e3-a81a-10f0ae7e9b5c"},{"name":"Get Form Submissions for form","id":"2b527f0b-0805-4e83-b156-bc8873308c23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.hyperforms.app/api/submissions/:id","description":"

Get all submissions from a particular form endpoint.

(required) Form Endpoint URL Key

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"2b527f0b-0805-4e83-b156-bc8873308c23"}],"id":"e89e2677-a894-4800-9b78-e8422aad8f51","description":"

The submissions endpoint allows you to get all the form submissions that have been made via your Hyperforms endpoints.

\n","_postman_id":"e89e2677-a894-4800-9b78-e8422aad8f51","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ee592a8d-476f-41d8-90d0-1582457aee67","id":"ee592a8d-476f-41d8-90d0-1582457aee67","name":"Hyperforms API","type":"collection"}}},{"name":"notifications","item":[{"name":"Get all Notification Email Addresses","id":"94b7b74d-9362-4d68-ac62-d7cd461c85db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.hyperforms.app/api/notifications","description":"

Get a list of all the notification email addresses associated with your account.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ee592a8d-476f-41d8-90d0-1582457aee67","id":"ee592a8d-476f-41d8-90d0-1582457aee67","name":"Hyperforms API","type":"collection"}},"urlObject":{"path":["notifications"],"host":["https://my.hyperforms.app/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"94b7b74d-9362-4d68-ac62-d7cd461c85db"},{"name":"Get all Notification Email Addresses for specified Form Endpoint","id":"4c05fb8b-3742-46ee-9495-bb140f112463","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.hyperforms.app/api/notifications/:id","description":"

Get all the notification email addresses associated with a particular form endpoint.

(required) Form Endpoint URL Key

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"4c05fb8b-3742-46ee-9495-bb140f112463"},{"name":"Add New Notification Email Address to Form.","id":"cb29db7d-e3d3-4247-8eb6-a0c45a5db993","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://my.hyperforms.app/api/notifications/:id?email=","description":"

Add new notification email address to a form endpoint.

(required) The notification email address you want to add to the form endpoint.

\n","type":"text/plain"},"key":"email","value":""}],"variable":[{"description":{"content":"

(required) Form Endpoint URL Key

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"cb29db7d-e3d3-4247-8eb6-a0c45a5db993"},{"name":"Delete Notification Email Address from Form Endpoint","id":"d1ad56f1-4e76-4cdd-923e-e4c5b6824101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://my.hyperforms.app/api/notifications/:id?email=","description":"

Delete a notification email address from a form endpoint.

(required) Notification Email Address you would like

\n","type":"text/plain"},"key":"email","value":""}],"variable":[{"description":{"content":"

(required) Form Endpoint URL Key

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"d1ad56f1-4e76-4cdd-923e-e4c5b6824101"}],"id":"691eeb75-3bda-4050-a205-d3192d163fa4","description":"

The notifications endpoint allows you to add/remove notification email addresses for your form endpoints.

\n","_postman_id":"691eeb75-3bda-4050-a205-d3192d163fa4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ee592a8d-476f-41d8-90d0-1582457aee67","id":"ee592a8d-476f-41d8-90d0-1582457aee67","name":"Hyperforms API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"9b46965a-2626-4ef8-8e85-62ce7bfb0687","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e982856c-2aa5-47f7-ac40-23ffc80ffe8e","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://my.hyperforms.app/api"},{"key":"bearerToken","value":""}]}