Access
Preconditions
Section titled “Preconditions”During the BETA phase, access to the API is by invitation. You can request access to the BETA program here.
Licensing
Section titled “Licensing”In order to use the API, a WorksManager Pro license is needed.
Account Owner Access
Section titled “Account Owner Access”If you do not know who has owner-level access to an account, the Trimble Admin Console may allow you to view existing account owners filtering by role on the users page within the account. If that function is not available, no account owner is listed, or if the owner listed is no longer valid, let us know.
Initial API Transaction
Section titled “Initial API Transaction”If not yet familiar with Trimble ID authentication, view our guide on how to perform an initial API transaction.
Next, view our API documentation and the OpenAPI definition to begin developing an integration with the API.
The new API product in the Developer Console is available via the following regional deployment(s):
| Region | URL |
|---|---|
| * | https://cloud.api.trimble.com/site-management/v1 |
Scopes
Section titled “Scopes”If using the API with a client application created in the Developer Console, scopes define the access granted to a Trimble ID access token. Include only the scopes needed to enable intended functionality when performing an access token call.
| Name | Access |
|---|---|
site-management | Access to the entire Civil Site Management API. |
This documentation will be updated if and when new scopes are introduced.