Formstack Documents

Automatically populate templates with data from your favorite cloud apps. Never copy & paste again!

Status: Preview

Tier: Standard

Version: 1.0.0

Actions:

Name	Summary
GetDocuments ([Optional]string search, [Optional]string folder)	Get Documents
GetDocumentFields (number id, [internal]string format)	Get Document Fields
MergeDocument (number id, MergeDocumentParameterFields fields, [internal]string download)	Merge Document
GetRoutes ([Optional]string search, [Optional]string folder)	Get Data Routes
GetRouteFields (number id, [internal]string format)	Get Data Route Fields
MergeRoute (number id, MergeRouteParameterFields fields, [internal]string download, [internal]string list_files)	Merge Data Route

Triggers:

Name

Summary

Objects:

Name	Summary
Document
Field
File
MergedDocument
MergeDocumentParameterFields
MergedRoute
MergeRouteParameterFields
Route

Actions:

GetDocuments

Summary: Get Documents

Description: This endpoint returns information about the documents in a user's account. The response includes the display name and other details about each documents.

Syntax:

FormstackDocuments.GetDocuments ([Optional]string search, [Optional]string folder)

Parameters:

Name

Type

Summary

Required

Related Action

string

(Search string)

Search documents for this string.

False

folder

string

(Folder name)

Return list of documents in this folder.

False

Returns:

Type:array of (Document)

GetDocumentFields

Summary: Get Document Fields

Description: This endpoint returns the fields inside the selected document.

Syntax:

FormstackDocuments.GetDocumentFields (number id, [internal]string format)

Parameters:

Name

Type

Summary

Required

Related Action

number

(Document ID)

The Document ID to query.

True

format

string

True

Returns:

Type:array of (Field)

MergeDocument

Summary: Merge Document

Description: This endpoint merges data into a document.

Syntax:

FormstackDocuments.MergeDocument (number id, MergeDocumentParameterFields fields, [internal]string download)

Parameters:

Name	Type	Summary	Required	Related Action
id	number (Pick Document)	The Document ID to merge.	True	GetDocuments
fields	MergeDocumentParameterFields	An object that represents the posting of fields.	True
download	string		True

Returns:

Type:MergedDocument

GetRoutes

Summary: Get Data Routes

Description: This endpoint returns information about the data routes in a user's account. The response includes the display name and other details about each data route.

Syntax:

FormstackDocuments.GetRoutes ([Optional]string search, [Optional]string folder)

Parameters:

Name

Type

Summary

Required

Related Action

string

(Search string)

Search data routes for this string.

False

folder

string

(Folder name)

Return list of data routes in this folder.

False

Returns:

Type:array of (Route)

GetRouteFields

Summary: Get Data Route Fields

Description: This endpoint returns the fields inside the selected data route.

Syntax:

FormstackDocuments.GetRouteFields (number id, [internal]string format)

Parameters:

Name

Type

Summary

Required

Related Action

number

(Date Route ID)

Data Route ID

True

format

string

True

Returns:

Type:array of (Field)

MergeRoute

Summary: Merge Data Route

Description: This endpoint merges data into a data route.

Syntax:

FormstackDocuments.MergeRoute (number id, MergeRouteParameterFields fields, [internal]string download, [internal]string list_files)

Parameters:

Name	Type	Summary	Required	Related Action
id	number (Pick Data Route)	The Data Route ID.	True	GetRoutes
fields	MergeRouteParameterFields	An object that represents the posting of fields.	True
download	string		True
list_files	string		True

Returns:

Type:MergedRoute

Document

Summary:

Description:

Properties:

Name	Type	Summary
id	number Document ID	Unique identifier representing the specific document.
key	string Document Key	Unique key used to authenticate a document during merge.
type	string Type	The type of document (template type).
name	string Name	The name of the document.
output_name	string Output Name	The name of the merged document.
size_width	string Width	The page width of the PDF.
size_height	string Height	The page height of the PDF.
active	number Active	A 1/0 boolean indicating if the document is active.
url	string Merge URL	The Merge URL for the document.
fields	array of (Field) Fields	The fields inside the document.

Field

Summary:

Description:

Properties:

Name

Type

Summary

key

string

Key

Unique identifier for the merge field.

name

string

Name

The name of the merge field.

File

Summary:

Description:

Properties:

Name	Type	Summary
name	string File Name	The name of the file.
url	string Merged Document URL	The temporary URL to the merged document.
document_id	string Merged Document ID	The ID of the merged document.

MergedDocument

Summary:

Description:

Properties:

Name	Type	Summary
success	number Success Response	Will return 1 if the request was a success.
name	string File Name	The name of the merged file.
url	string Merged Document URL	The temporary URL to the merged document.

MergeDocumentParameterFields

Summary:

Description: An object that represents the posting of fields.

Properties:

Name

Type

Summary

MergedRoute

Summary:

Description:

Properties:

Name

Type

Summary

success

number

Success Response

Will return 1 if the request was a success.

files

array of (File)

Files

The files from the data route.

MergeRouteParameterFields

Summary:

Description: An object that represents the posting of fields.

Properties:

Name

Type

Summary

Route

Summary:

Description:

Properties:

Name	Type	Summary
id	number Route ID	Unique identifier for the data route.
key	string Route Key	Unique key used to authenticate a data route during merge.
name	string Name	The name of the data route.
url	string Merge URL	The Merge URL for the data route.
fields	array of (Field) Fields	The fields inside the data route.