TrueContext REST API

The TrueContext REST APIClosed 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.

Info:For a complete OpenAPI definition of the TrueContext REST API, visit our API Documentation page.

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.com as 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 the Intelligent and Elite tiers:

—Digital
Intelligent
Elite
?

Info:API responses that return submission data show submitted values, even when the record has a draft. For records in the Started state that haven't been submitted, they show the draft values instead. For details, go to Values in exports and outputs when a draft exists.

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}
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

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 resourcesClosed 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.

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}
POST
/api/1.1/data/{dataId}/assign
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}
POST
/api/1.1/data/{dataId}/unassign
POST
/api/1.1/data/{dataId}/rescope

Form Submission Corrections

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

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

TrueContext Teamwork

ReassignClosed Assigning and reassigning control which users are responsible for dispatched records, Started records that have a draft, and incomplete TrueContext Teamwork records. A dispatcher with the "Can Manage Assignments" FormSpace permission can assign or reassign a record, and field users can claim unassigned records from the Group Inbox. Supervisors can reassign an incomplete TrueContext Teamwork record to another user or to the FormSpace, even if a user already has it. incomplete TrueContext TeamworkClosed 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. Use POST /api/1.1/data/{dataId}/assign or POST /api/1.1/data/{dataId}/unassign. The TrueContext TeamworkClosed 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. /reassign endpoint is deprecated.

POST
DEPRECATED
/api/1.1/data/{dataId}/reassign

Note:If you're using this endpoint, update your integrations. To reassign a record to a user, use POST /api/1.1/data/{dataId}/assign. This works for an incomplete TrueContext Teamwork-enabled record even if a user already has it. To unassign an incomplete TrueContext Teamwork-enabled record so that other users can claim it, use POST /api/1.1/data/{dataId}/unassign. The form must be set up for claiming. To make a dispatched record available to a group or FormSpace, use POST /api/1.1/data/{dataId}/rescope.

Users

Manage and take action on your user accounts

POST
/api/1.1/users
GET
/api/1.1/users/{userId}
PUT
DEPRECATED
/api/1.1/users/{userId}
PATCH
/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
/api/1.1/users/user
GET
DEPRECATED
/api/1.1/users/username/{username}

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

Groups

Manage groups, membership, and FormSpace access

POST
/api/1.1/groups
GET
/api/1.1/groups/{groupId}
PUT
DEPRECATED
/api/1.1/groups/{groupId}
PATCH
/api/1.1/groups/{groupId}
DELETE
/api/1.1/groups/{groupId}
GET
/api/1.1/groups/{groupId}/users
DELETE
/api/1.1/groups/{groupId}/users
PATCH
/api/1.1/groups/{groupId}/users
GET
/api/1.1/groups/{groupId}/formspaces
POST
/api/1.1/groups/{groupId}/formspaces
DELETE
/api/1.1/groups/{groupId}/formspaces
PATCH
/api/1.1/groups/{groupId}/formspaces