{"_id":"5434928b0ef9c0080016520e","category":{"_id":"5434918d0ef9c008001651ff","pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-08T01:21:17.804Z","from_sync":false,"order":1,"slug":"rest-api","title":"REST API"},"parentDoc":null,"user":"543469060ef9c00800164f01","version":{"_id":"54346a2a0ef9c00800164f28","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":7,"createdAt":"2014-10-07T22:33:14.982Z","releaseDate":"2014-10-07T22:33:14.982Z","categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"is_link":false,"__v":10,"project":"543469460ef9c00800164f0e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-08T01:25:31.500Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","try":true,"basic_auth":false,"auth":"never","params":[],"url":""},"isReference":false,"order":4,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Forms\"\n}\n[/block]\n[Forms](doc:forms) are how information is collected and defines how that information is stored\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /form](doc:form-get)\",\n    \"0-1\": \"Get all forms in your account\",\n    \"1-0\": \"[POST /form](doc:form-post)\",\n    \"1-1\": \"Add a new form to your account\",\n    \"2-0\": \"[GET /form/:id](doc:form-id-get)\",\n    \"2-1\": \"Get the details of the specified form\",\n    \"3-0\": \"[PUT /form/:id](doc:form-id-put)\",\n    \"3-1\": \"Update the specified form\",\n    \"4-0\": \"[DELETE /form/:id](doc:form-id-delete)\",\n    \"4-1\": \"Delete the specified form\",\n    \"5-0\": \"[POST /form/:id/copy](doc:form-id-copy-post)\",\n    \"5-1\": \"Create a copy of the specified form\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Folders\"\n}\n[/block]\n[Folders](doc:folders) are how you organize your forms and are one way to assign form permissions to a group of forms.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resourcve\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /folder](doc:folder-get)\",\n    \"0-1\": \"Get all folders in your account\",\n    \"1-0\": \"[POST /folder](doc:folder-post)\",\n    \"1-1\": \"Add a new folder to your account\",\n    \"2-0\": \"[GET /folder/:id](doc:folder-id-get)\",\n    \"2-1\": \"Get the details of the specified folder\",\n    \"3-0\": \"[PUT /folder/:id](doc:folder-id-put)\",\n    \"3-1\": \"Update the specified folder\",\n    \"4-0\": \"[DELETE /folder/:id](doc:folder-id-delete)\",\n    \"4-1\": \"Delete the specified folder\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Fields\"\n}\n[/block]\n[Fields](doc:fields) are the specific input elements that collect data for each form\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /form/:id/field](doc:form-id-field-get)\",\n    \"0-1\": \"Get all fields for the specified form\",\n    \"1-0\": \"[POST /form/:id/field](doc:form-id-field-post)\",\n    \"1-1\": \"Add a new field to the specified form\",\n    \"2-0\": \"[GET /field/:id](doc:field-id-get)\",\n    \"2-1\": \"Get the details of the specified field\",\n    \"3-0\": \"[PUT /field/:id](doc:field-id-put)\",\n    \"3-1\": \"Update the specified field\",\n    \"4-0\": \"[DELETE /field/:id](doc:field-id-delete)\",\n    \"4-1\": \"Delete the specified field\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Submissions\"\n}\n[/block]\n[Submissions](doc:submissions) are collections of data that has been submitted via a form\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /form/:id/submission](doc:form-id-submission-get)\",\n    \"0-1\": \"Get all submissions for the specified form\",\n    \"1-0\": \"[POST /form/:id/submission](doc:form-id-submission-post)\",\n    \"1-1\": \"Add a new submission to the specified form\",\n    \"2-1\": \"Get the details of the specified submission\",\n    \"2-0\": \"[GET /submission/:id](doc:submission-id-get)\",\n    \"3-0\": \"[PUT /submission/:id](doc:submission-id-put)\",\n    \"3-1\": \"Update the specified submission\",\n    \"4-0\": \"[DELETE /submission/:id](doc:submission-id-delete)\",\n    \"4-1\": \"Delete the specified submission\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Partial Submissions\"\n}\n[/block]\n[Partial Submissions](doc:partial-submissions) are collections of data that has been filled out on a form but not submitted. Required the Partial Submission plugin to be enabled on the form.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /form/:id/partialsubmission](doc:form-id-partialsubmission-get)\",\n    \"0-1\": \"Get all partial submissions for the specified form\",\n    \"1-0\": \"[GET /partialsubmission/:id](doc:partialsubmission-id-get)\",\n    \"1-1\": \"Get the details of the specified partial submission\",\n    \"2-0\": \"[DELETE /partialsubmission/:id](doc:partialsubmission-id-delete)\",\n    \"2-1\": \"Delete the specified partial submission\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Confirmation Emails\"\n}\n[/block]\n[Confirmations Emails](doc:confirmation-emails) are the emails that are sent to the form submitter with data from their form submission\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /form/:id/confirmation](doc:form-id-confirmation-get)\",\n    \"0-1\": \"Get all confirmation emails for the specified form\",\n    \"1-0\": \"[POST /form/:id/confirmation](doc:form-id-confirmation-post)\",\n    \"1-1\": \"Create a new confirmation email to the specified form\",\n    \"2-0\": \"[GET /confirmation/:id](doc:confirmation-id-get)\",\n    \"2-1\": \"Get the details of the specified confirmation email\",\n    \"3-0\": \"[PUT /confirmation/:id](doc:confirmation-id-put)\",\n    \"3-1\": \"Update the specified confirmation email\",\n    \"4-0\": \"[DELETE /confirmation/:id](doc:confirmation-id-delete)\",\n    \"4-1\": \"Delete the specified confirmation email\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Notification Emails\"\n}\n[/block]\n[Notification Emails](doc:notification-emails) are the emails that are sent to the form owner with data from each form submission\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /form/:id/notification](doc:form-id-notification-get)\",\n    \"1-0\": \"[POST /form/:id/notification](doc:form-id-notification-post)\",\n    \"2-0\": \"[GET /notification/:id](doc:notification-id-get)\",\n    \"3-0\": \"[PUT /notification/:id](doc:notification-id-put)\",\n    \"4-0\": \"[DELETE /notification/:id](doc:notification-id-delete)\",\n    \"0-1\": \"Get all notification emails for the specified form\",\n    \"1-1\": \"Add a new notification email to the specified form\",\n    \"2-1\": \"Get details for the specified notification email\",\n    \"3-1\": \"Update the specified notification email\",\n    \"4-1\": \"Delete the specified notification email\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Webhooks\"\n}\n[/block]\n[Webhooks](doc:webhooks) are automatic notifications (server to server communication) that are triggered with each form submission\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Resource\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[GET /form/:id/webhook](doc:form-id-webhook-get)\",\n    \"0-1\": \"Get all webhooks for the specified form\",\n    \"1-0\": \"[POST /form/:id/webhook](doc:form-id-webhook-post)\",\n    \"1-1\": \"Add a new webhook to the specified form\",\n    \"2-0\": \"[GET /webhook/:id](doc:webhook-id-get)\",\n    \"2-1\": \"Get details for the specified webhook\",\n    \"3-0\": \"[PUT /webhook/:id](doc:webhook-id-put)\",\n    \"3-1\": \"Update the specified webhook\",\n    \"4-0\": \"[DELETE /webhook/:id](doc:webhook-id-delete)\",\n    \"4-1\": \"Delete the specified webhook\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"resources","type":"basic","title":"Resources"}
[block:api-header] { "type": "basic", "title": "Forms" } [/block] [Forms](doc:forms) are how information is collected and defines how that information is stored [block:parameters] { "data": { "h-0": "Resource", "h-1": "Description", "0-0": "[GET /form](doc:form-get)", "0-1": "Get all forms in your account", "1-0": "[POST /form](doc:form-post)", "1-1": "Add a new form to your account", "2-0": "[GET /form/:id](doc:form-id-get)", "2-1": "Get the details of the specified form", "3-0": "[PUT /form/:id](doc:form-id-put)", "3-1": "Update the specified form", "4-0": "[DELETE /form/:id](doc:form-id-delete)", "4-1": "Delete the specified form", "5-0": "[POST /form/:id/copy](doc:form-id-copy-post)", "5-1": "Create a copy of the specified form" }, "cols": 2, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Folders" } [/block] [Folders](doc:folders) are how you organize your forms and are one way to assign form permissions to a group of forms. [block:parameters] { "data": { "h-0": "Resourcve", "h-1": "Description", "0-0": "[GET /folder](doc:folder-get)", "0-1": "Get all folders in your account", "1-0": "[POST /folder](doc:folder-post)", "1-1": "Add a new folder to your account", "2-0": "[GET /folder/:id](doc:folder-id-get)", "2-1": "Get the details of the specified folder", "3-0": "[PUT /folder/:id](doc:folder-id-put)", "3-1": "Update the specified folder", "4-0": "[DELETE /folder/:id](doc:folder-id-delete)", "4-1": "Delete the specified folder" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Fields" } [/block] [Fields](doc:fields) are the specific input elements that collect data for each form [block:parameters] { "data": { "h-0": "Resource", "h-1": "Description", "0-0": "[GET /form/:id/field](doc:form-id-field-get)", "0-1": "Get all fields for the specified form", "1-0": "[POST /form/:id/field](doc:form-id-field-post)", "1-1": "Add a new field to the specified form", "2-0": "[GET /field/:id](doc:field-id-get)", "2-1": "Get the details of the specified field", "3-0": "[PUT /field/:id](doc:field-id-put)", "3-1": "Update the specified field", "4-0": "[DELETE /field/:id](doc:field-id-delete)", "4-1": "Delete the specified field" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Submissions" } [/block] [Submissions](doc:submissions) are collections of data that has been submitted via a form [block:parameters] { "data": { "h-0": "Resource", "h-1": "Description", "0-0": "[GET /form/:id/submission](doc:form-id-submission-get)", "0-1": "Get all submissions for the specified form", "1-0": "[POST /form/:id/submission](doc:form-id-submission-post)", "1-1": "Add a new submission to the specified form", "2-1": "Get the details of the specified submission", "2-0": "[GET /submission/:id](doc:submission-id-get)", "3-0": "[PUT /submission/:id](doc:submission-id-put)", "3-1": "Update the specified submission", "4-0": "[DELETE /submission/:id](doc:submission-id-delete)", "4-1": "Delete the specified submission" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Partial Submissions" } [/block] [Partial Submissions](doc:partial-submissions) are collections of data that has been filled out on a form but not submitted. Required the Partial Submission plugin to be enabled on the form. [block:parameters] { "data": { "h-0": "Resource", "h-1": "Description", "0-0": "[GET /form/:id/partialsubmission](doc:form-id-partialsubmission-get)", "0-1": "Get all partial submissions for the specified form", "1-0": "[GET /partialsubmission/:id](doc:partialsubmission-id-get)", "1-1": "Get the details of the specified partial submission", "2-0": "[DELETE /partialsubmission/:id](doc:partialsubmission-id-delete)", "2-1": "Delete the specified partial submission" }, "cols": 2, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Confirmation Emails" } [/block] [Confirmations Emails](doc:confirmation-emails) are the emails that are sent to the form submitter with data from their form submission [block:parameters] { "data": { "h-0": "Resource", "h-1": "Description", "0-0": "[GET /form/:id/confirmation](doc:form-id-confirmation-get)", "0-1": "Get all confirmation emails for the specified form", "1-0": "[POST /form/:id/confirmation](doc:form-id-confirmation-post)", "1-1": "Create a new confirmation email to the specified form", "2-0": "[GET /confirmation/:id](doc:confirmation-id-get)", "2-1": "Get the details of the specified confirmation email", "3-0": "[PUT /confirmation/:id](doc:confirmation-id-put)", "3-1": "Update the specified confirmation email", "4-0": "[DELETE /confirmation/:id](doc:confirmation-id-delete)", "4-1": "Delete the specified confirmation email" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Notification Emails" } [/block] [Notification Emails](doc:notification-emails) are the emails that are sent to the form owner with data from each form submission [block:parameters] { "data": { "h-0": "Resource", "h-1": "Description", "0-0": "[GET /form/:id/notification](doc:form-id-notification-get)", "1-0": "[POST /form/:id/notification](doc:form-id-notification-post)", "2-0": "[GET /notification/:id](doc:notification-id-get)", "3-0": "[PUT /notification/:id](doc:notification-id-put)", "4-0": "[DELETE /notification/:id](doc:notification-id-delete)", "0-1": "Get all notification emails for the specified form", "1-1": "Add a new notification email to the specified form", "2-1": "Get details for the specified notification email", "3-1": "Update the specified notification email", "4-1": "Delete the specified notification email" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Webhooks" } [/block] [Webhooks](doc:webhooks) are automatic notifications (server to server communication) that are triggered with each form submission [block:parameters] { "data": { "h-0": "Resource", "h-1": "Description", "0-0": "[GET /form/:id/webhook](doc:form-id-webhook-get)", "0-1": "Get all webhooks for the specified form", "1-0": "[POST /form/:id/webhook](doc:form-id-webhook-post)", "1-1": "Add a new webhook to the specified form", "2-0": "[GET /webhook/:id](doc:webhook-id-get)", "2-1": "Get details for the specified webhook", "3-0": "[PUT /webhook/:id](doc:webhook-id-put)", "3-1": "Update the specified webhook", "4-0": "[DELETE /webhook/:id](doc:webhook-id-delete)", "4-1": "Delete the specified webhook" }, "cols": 2, "rows": 5 } [/block]