Formdesk REST API v1

All methods (execpt the Connect method) of the REST API cost 1 credit per call unless otherwise stated in the documentation. The number of remaining credits is returned after each call via the http header 'Credits'.

The Bearer token in the Authorization header is the API Key which can be found or created within the User Management in your Formdesk account.

An example of the complete authorization header:
Authorization: Bearer 35491370a3144829b6977327e494b4d5

Resource URL

The resource URL must have the following format:
https://[host]/api/rest/v1/[folder of forms]/

Host:
For the Connect this is always 'www.formdesk.com'. With all other calls you need to use the host returned by the Connect method, e.g. 'fd7.formdesk.com'.

Folder of forms:
This is also called 'domain'. It is the unique account name you can find within your account settings. It is also the first part in the url (after the host) to a form or when logged-in to Formdesk.

Response

When an api call is successful, status code 200 is returned. Otherwise the the status code indicates a failure and a Json structure is returned in the body of the response.

Example:

{
    "meta": {
        "resourceType": "Error"
    },
    "code": "400",
    "description": "Bad Request",
    "reason": "Form not found"
}