Explanation and Concepts

Getting Started

API endpoints are grouped by area and service (see the API Definition). Each definition describes request and response shapes; the interactive reference includes schema detail and download of the specification.

Before You Start

There is no special set-up required to use the Trimble Unity Maintain and Permit APIs beyond a fully configured instance with API access enabled for your account. Access is granted by account administrators. Once enabled and you have an API access key, use the API for transactional integrations subject to the Trimble Unity API Acceptable Use Policy.

An API user should be created for integrations: typically a system user dedicated to API access (not an individual’s login), with permissions appropriate to the workflows you automate.

Transactional alignment: Use cases should facilitate user-initiated actions or real-time synchronization between Trimble Unity and authorized third-party systems.

Domain concepts

Specific entities (assets, permits, work orders, and so on) are defined in your product documentation and reflected in the OpenAPI components/schemas and operation descriptions. Use the API Overview to read the full overview and explore modules and models for your deployment.