TrueContext REST API
To support both new and existing integrations, the TrueContext REST API will continue to use api.prontoforms.com as the base URL.
For more detailed information about what’s changing, visit https://support.truecontext.com/hc/en-us/articles/19516168513556
The TrueContext REST API supports integration with your company’s proprietary systems. This page includes a list of the API endpoints you can use to automate actions in TrueContext.
Info:For a complete OpenAPI definition of the TrueContext REST API, visit our API Documentation page.
Available on the Advanced and Enterprise tiers:
FormSpaces
Retrieve information related to your team’s FormSpaces
|
|
|
|
Forms
Retrieve information related to your team’s forms
|
|
|
|
|
GET
/api/1.1/formspaces/{formSpaceId}/forms/{formId}/iterations
|
|
GET
/api/1.1/formspaces/{formSpaceId}/forms/{formId}/iterations/{formVersionId}
|
Data Exports
Export data from dispatched and submitted forms for a specific form
|
POST
/api/1.1/formspaces/{formSpaceId}/forms/{formId}/data/export
|
|
GET
/api/1.1/formspaces/{formSpaceId}/forms/{formId}/data/export/{dataExportId}/status
|
|
GET
/api/1.1/formspaces/{formSpaceId}/forms/{formId}/data/export/{dataExportId}
|
Documents
Retrieve information related to your team’s documents
|
|
|
|
Resources
Retrieve information and take action on your team's resources
|
|
|
|
|
|
|
|
|
PUT
/api/1.1/formspaces/{formSpaceId}/resources/{resourceId}/upload.{extension}
|
Data Destinations
Retrieve information and take action on your Data Destinations
A Data Destination specifies where to send data from a submitted form. You can use Data Destinations to automate data sharing and storage, routing data to a specific service (such as email or cloud storage) in several different formats.
|
GET
/api/1.1/formspaces/{formSpaceId}/destinations
|
|
GET
/api/1.1/formspaces/{formSpaceId}/destinations/{destinationId}
|
|
GET
/api/1.1/data/{dataId}/destinations/{destinationId}
|
|
POST
/api/1.1/data/{dataId}/destinations/{destinationId}
|
|
POST
/api/1.1/data/{dataId}/destinations/execute
|
|
POST
/api/1.1/data/{dataId}/destinations/{destinationId}/execute
|
Executions
Take action on the executions that Form Submissions trigger
|
GET
/api/1.1/data/{dataId}/executions/{executionId}
|
|
POST
/api/1.1/data/{dataId}/executions/{executionId}
|
|
|
|
POST
/api/1.1/data/{dataId}/executions/{executionId}/execute
|
Dispatch Forms
Dispatch The term "dispatch" refers to the act of sending a form to a mobile user or customer. Typically, a dispatched form includes some information pre-filled to give the recipient context for the work to be done. Dispatch can be manual or automated (using a Dispatch Data Destination or the TrueContext REST API). forms to your users to initiate a workflow
|
|
|
|
|
|
|
|
Form Submission Editing
Send completed Form Submissions for editing or cancel a request for editing
|
|
|
|
TrueContext Teamwork
Unassign or assign incomplete TrueContext Teamwork TrueContext Teamwork is an Enterprise tier feature that enables mobile users to transfer incomplete forms for other users to complete as part of a multi-user workflow. This can be useful for jobs that require someone else's expertise or that span multiple shifts.-enabled forms (Enterprise tier only)
|
|
|
|
Users
Manage and take action on your user accounts
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET
DEPRECATED
/api/1.1/users/username/{username}
Note:If you are using this endpoint, update your integrations to use |