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.
The TrueContext REST API uses API Keys for basic authentication. You can create a key that grants full access or a Read-Only key for access to read-only operations. Our API documentation describes how to create an API Key.
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 Sources
Manage and take action on your Data Sources
|
|
|
POST
/api/1.1/formspaces/{formSpaceId}/sources/{sourceId}/fetch
|
PUT
/api/1.1/formspaces/{formSpaceId}/sources/{sourceId}/upload.{extension}
|
GET
/api/1.1/formspaces/{formSpaceId}/sources/{sourceId}/content.{extension}
|
Data Destinations
Retrieve information and take action on your Data Destinations
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
|
Form Submission Editing
Send completed Form Submissions for editing or cancel a request for editing
|
|
TrueContext Teamwork
Unassign or assign incomplete TrueContext Teamwork-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 |