API Reference

All Resources

All Smarter Drafter API Resources can be found here

Folders

Folders are used to organise forms

ResourceDescription
GET /Folders/LibraryGets the library of client folders

Forms

Forms are built as an automation using fields, and are sent to users to complete

ResourceDescription
GET /Forms/:id/FieldsReturns fields from a specified form
GET /Forms/:idReturns a specified form
GET /FormsSearch for forms with specified query parameters

Submissions

Submissions are completed forms, often with generated documents

ResourceDescription
GET /Submissions/:idRetrieves a submission by its ID
GET /SubmissionsSearch for a submission using query parameters
GET /Submissions/:id/:fileNameDownload the generated document
GET /Submissions/:id/:fieldRef/:fileNameDownload the submission answer file
POST /SubmissionsCreates a new submission
PUT /Submissions/:id/UpdateAnswer/:fieldRefUpdate answers for a specified field in a specified submission
PUT /Submissions/:id/SubmitSubmits a specified submission and queues it for document generation, if a template exists
DELETE /Submissions/:id/:permanentlyDeletes a specified submission