{"_id":"553591ce63cc650d00312929","createdAt":"2015-04-20T21:45:10.508Z","excerpt":"Version 2.0","project":"55357364e02d480d0003c6d3","__v":21,"githubsync":"","hidden":false,"slug":"getting-started","title":"Introduction","updates":[],"version":"553591cd63cc650d00312925","api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"body":"The GoFormz API provides a way for anyone with a GoFormz account to programmatically access and update their data.  Users have access to all data that has been entered into any form in your account.  You can also retrieve values such as signatures, images, and GPS data that would not be included in a standard export. \n\nThe following list details some of the common use cases for the GoFormz API:\n- Retrieve completed or draft formz and all associated data.\n- Delete formz once the data is harvested. \n- Create form drafts with pre-populated information.  \n- Download PDFs generated from formz\n\nThe GoFormz API tries hard to follow [REST](http://en.wikipedia.org/wiki/Representational_state_transfer) principles when possible.  Our API groups requests by resources and uses standard `HTTP` response codes to indicate API errors.  [JSON](http://www.json.org/) is the standard format the API uses for all `HTTP` `POST`, `PUT`, and `PATCH` operation request bodies.  Also,  [JSON](http://www.json.org/) will be returned in all responses from the API, including errors.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Access\"\n}\n[/block]\nCurrently, access to the GoFormz API is restricted to users who have an an Advanced subscription or higher.  \n\nContact [support:::at:::goformz.com](mailto:support@goformz.com?Subject=Upgrade Account for API Access) if you want to upgrade your account.","category":"553591cd63cc650d00312926","link_external":false,"type":"basic","isReference":false,"link_url":"","order":0,"sync_unique":"","user":"55356ede6040a20d00454508","parentDoc":null,"childrenPages":[]}

Introduction

Version 2.0

The GoFormz API provides a way for anyone with a GoFormz account to programmatically access and update their data. Users have access to all data that has been entered into any form in your account. You can also retrieve values such as signatures, images, and GPS data that would not be included in a standard export. The following list details some of the common use cases for the GoFormz API: - Retrieve completed or draft formz and all associated data. - Delete formz once the data is harvested. - Create form drafts with pre-populated information. - Download PDFs generated from formz The GoFormz API tries hard to follow [REST](http://en.wikipedia.org/wiki/Representational_state_transfer) principles when possible. Our API groups requests by resources and uses standard `HTTP` response codes to indicate API errors. [JSON](http://www.json.org/) is the standard format the API uses for all `HTTP` `POST`, `PUT`, and `PATCH` operation request bodies. Also, [JSON](http://www.json.org/) will be returned in all responses from the API, including errors. [block:api-header] { "type": "basic", "title": "API Access" } [/block] Currently, access to the GoFormz API is restricted to users who have an an Advanced subscription or higher. Contact [support@goformz.com](mailto:support@goformz.com?Subject=Upgrade Account for API Access) if you want to upgrade your account.