TrueContext REST API
The TrueContext REST API
The TrueContext REST API enables developers to update and manage data communicated between TrueContext and their external, third-party systems. Admins can call our API endpoints after they set up an API application and API Key. 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. This topic describes how to create an API Key.
Note:
-
Although we're now TrueContext, the REST API continues to use
api.prontoforms.comas its base URL to preserve existing integrations. -
The TrueContext REST API supports server-to-server integrations only. Call the API from a backend service — browsers block client-side calls because the API does not return CORS headers.
Available on all 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}
|
|
GET
/api/1.1/formspaces/{formSpaceId}/forms/{formId}/iterations/{formVersionId}/report
|
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 Resources are materials that field technicians can access while they work on records in the Mobile App. A resource might be a Resource Document, like a manual or a floor plan, or a Resource Image, like a schematic or a diagram. Resources are uploaded to a FormSpace and can be referenced in forms or made available in the Resource Library.
|
|
|
|
|
|
|
|
|
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 record 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 Assigning and reassigning control which users are responsible for dispatched records. A dispatcher with the "Can Manage Assignments" FormSpace permission can assign a record to a user or group and reassign it if the original assignee is unavailable. Field users can also claim unassigned records from the Group Inbox. incomplete TrueContext Teamwork TrueContext Teamwork is a 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
|
|
|
POST
|
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 |
Groups
Manage groups, membership, and FormSpace FormSpaces are where forms are stored and organized in the TrueContext Web Portal. A TrueContext Team may have multiple FormSpaces, depending on their needs. Admins can set FormSpace permissions to control which users have access to the forms in that FormSpace. access
|
|
|
|
|
|
|
|
|
|
|
|
|
POST
/api/1.1/groups/{groupId}/users
|
|
|
|
|
|
|
|
|
|
|
|
|