tc_companies
Manage Trimble Connect companies and their members. List, get, update companies, add or remove users and email domains.
Instructions
Trimble Connect Companies and company members. Select the endpoint with the "action" parameter. Path placeholders {projectId}/{id}/{subId}/{extraId}/{version} are filled from the matching input parameters. Actions:
list: GET /companies
get: GET /companies/{id} — id=companyId
update: PATCH /companies/{id} — id=companyId, body: fields to update
list_users: GET /companies/{id}/users — id=companyId
add_users: POST /companies/{id}/users — id=companyId, body: users to add
update_user: PATCH /companies/{id}/users/{subId} — id=companyId, subId=userId, body: role...
remove_user: DELETE /companies/{id}/users/{subId} — id=companyId, subId=userId
remove_users: DELETE /companies/{id}/users — id=companyId, body: users to remove
add_domains: PATCH /companies/{id}/domains — id=companyId, body: email domains to add
remove_domains: DELETE /companies/{id}/domains — id=companyId, body: email domains to remove
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Primary resource ID — required when the action path contains {id} | |
| body | No | JSON request body for POST/PUT/PATCH (and some DELETE) actions | |
| query | No | Query parameters as key-value pairs | |
| subId | No | Secondary resource ID — required when the action path contains {subId} | |
| action | Yes | Endpoint to call (see tool description) | |
| region | Yes | Trimble Connect region: us (North America), eu (Europe), ap (Asia-Pacific), ap-au (Australia) | |
| extraId | No | Tertiary resource ID — required when the action path contains {extraId} | |
| version | No | Version number — required when the action path contains {version} | |
| projectId | No | Project ID — required when the action path contains {projectId} | |
| bcfVersion | No | BCF API version for BCF actions (default 2.1) |