Formstack Documents API Documentation
This is the complete API documentation for connecting to the Formstack Documents API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Formstack Documents: Formstack Documents: Create, merge, and deliver automated documents. Keep reading to get started.
Quickstart
Before you run your first Formstack Documents request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Formstack Documents connection — create or choose one in Connections. Note its
connectionId.
Every Formstack Documents action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/formstackDocuments/actions/{actionSlug}/runYou need a MindCloud API Key and a Formstack Documents connection. Then call an action such as List Documents:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/formstackDocuments/actions/list-documents/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Formstack Documents account. See Formstack Documents API Authentication for the full flow and how to get your connection credentials.
Formstack Documents actions
All 26 published actions for this Formstack Documents version. Each page documents the endpoint, arguments, and response controls.
- POSTCombine Files
- POSTCompress PDF
- POSTConvert File to PDF
- POSTCopy Document
- POSTCreate Data Route
- POSTCreate Data Route Delivery
- POSTCreate Document
- POSTCreate Document Delivery
- DELETEDelete Data Route
- DELETEDelete Document
- POSTEncrypt PDF
- GETGet Data Route
- GETGet Document
- GETGet Document File
- GETList Data Route Deliveries
- GETList Data Route Fields
- GETList Data Route Rules
- GETList Data Routes
- GETList Document Deliveries
- GETList Document Fields
- GETList Documents
- POSTMerge Data Route
- POSTMerge Document
- POSTSplit PDF
- PUTUpdate Data Route
- PUTUpdate Document
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.