Getting Started

The Trimble Unity Construct documentation is built using the OpenAPI 3.0 documentation standard. This provides a consistent method for describing endpoints and providing request/ response examples as well as code samples. The endpoints are grouped together by module. Each module and its endpoints are further described to help developers understand their usage. Each endpoint also includes a mock response example and response schema.

Before You Start

There is no special set-up required to use the Trimble Unity Construct API; however, the instance should be fully configured and must be in use. Access to the API is granted by account administrators. Once your account is enabled for API Access, and you are granted an API Access Key, you can use the API for transactional integrations subject to the Trimble Unity API Acceptable Use Policy.

An API user is required to be created to use the APIs. This user should not be an individual user but should be a system user created specifically for API access. An API user is expected to have full administrative permissions to interact with the APIs effectively, and therefore should not be an individual user.