Endpoints

Before you can access any of the available endpoints, make sure to create a valid access token. Also make sure to read the introduction to get familiar with our API.

Workspace

Method: GET

To get access to a workspace, use the /workspace endpoint.

$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';
 
curl https://deftform.com/api/v1/workspace \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

Forms and fields

Method: GET

Use the /forms endpoint to fetch all forms and their fields.

$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';
 
curl https://deftform.com/api/v1/forms \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

Form responses

Method: GET

To get all responses for a specific form, use the endpoint /responses/{formId}. {formId} is the ID you can find in the form detail page (in the lower right corner) and also via the API endpoint /forms. A form ID looks something like this: OUm6T9

$access_token = 't8ZMQLQiquuyMjHFqfqW0hlEvQsNioCQLLe9npgZ';
 
curl https://deftform.com/api/v1/responses/{formID} \
    -H "Authorization: Bearer $access_token" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'