TrueContext REST API

Info:We're now TrueContext.

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.

FormSpaces

Retrieve information related to your team’s FormSpaces

GET
/api/1.1/formspaces{formSpaceId}

Forms

Retrieve information related to your team’s forms

GET
/api/1.1/formspaces/{formSpaceId}/forms
GET
/api/1.1/formspaces/{formSpaceId}/forms/{formId}
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

GET
/api/1.1/formspaces/{formSpaceId}/documents
GET
/api/1.1/formspaces/{formSpaceId}/documents/{documentId}

Resources

Retrieve information and take action on your team's resources

GET
/api/1.1/formspaces/{formSpaceId}/resources
GET
/api/1.1/formspaces/{formSpaceId}/resources/{resourceId}
DELETE
/api/1.1/formspaces/{formSpaceId}/resources/{resourceId}
GET
/api/1.1/formspaces/{formSpaceId}/resources/{resourceId}/contents
PUT
/api/1.1/formspaces/{formSpaceId}/resources/{resourceId}/upload.{extension}

Data Sources

Manage and take action on your Data SourcesClosed Data sources, also known as "Lookups", are external sources of data that you upload or connect to TrueContext. You can reference this data in a form to populate answers or answer options. Data sources save typing, reduce errors, and make it easy to provide mobile users with only the relevant, most current data.

GET
/api/1.1/formspaces/{formSpaceId}/sources
GET
/api/1.1/formspaces/{formSpaceId}/sources/{sourceId}
DELETE
/api/1.1/formspaces/{formSpaceId}/sources/{sourceId}
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 DestinationsClosed 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

Form Submissions

Manage and take action on dispatched and submitted forms

GET
/api/1.1/data/{dataId}
DELETE
/api/1.1/data/{dataId}
GET
/api/1.1/data{dataId}/attachments.zip
GET
/api/1.1/data/{dataId}/attachments/{attachmentId}
GET
/api/1.1/data/{dataId}/document.{extension}
GET
/api/1.1/data/{dataId}/documents/{documentId}

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/execute
POST
/api/1.1/data/{dataId}/executions/{executionId}/execute

Form Submission Editing

Send completed Form Submissions for editing or cancel a request for editing

POST
/api/1.1/data/{dataId}/cancel_edit

Users

Manage and take action on your user accounts

POST
/api/1.1/users
GET
/api/1.1/users/{userId}
PUT
/api/1.1/users/{userId}
DELETE
/api/1.1/users/{userId}
POST
/api/1.1/users/{userId}/expirepassword
POST
/api/1.1/users/{userId}/password
GET
DEPRECATED
/api/1.1/users/username/{username}

Note:If you are using this endpoint, update your integrations to use /api/1.1/users/user.