Trimble Companies API

APIs related to Companies

GitHub OpenAPI

Operations 11

GET /companies List Companies #
GET /companies/{companyId} Get Company Details #
PATCH /companies/{companyId} Update Company #
PATCH /companies/{companyId}/domains Add Company Email Domains #
DELETE /companies/{companyId}/domains Remove Company Email Domains #
POST /companies/{companyId}/image Upload Company Image #
GET /companies/{companyId}/users List Users in a Company #
POST /companies/{companyId}/users Add Users to Company #
DELETE /companies/{companyId}/users Remove Users from Company #
PATCH /companies/{companyId}/users/{userId} Update User in the Company #
DELETE /companies/{companyId}/users/{userId} Remove User from the Company #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-companies-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trimble-companies-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Companies API
  description: '# Overview

    The Trimble Connect API allows you to read, write, and update data into and out of the Connect platform. Now, you can create folders, upload and download files, modify views, and do much more from any application.


    Documentation for this service is available on the Trimble Developer site.


    # Getting started

    **You must agree to the Terms of Service to use Connect services.**


    You need to complete the steps in the Getting started guide to be able to call the API.


    # Concepts

    Please see Common Concepts in the Connect Platform documentation.


    ## Paginated Responses

    All collections/lists support a Range header to fetch partial lists (HTTP 206) - the positions are zero-indexed & inclusive


    + Request Header

    ```

    Range: items=25-34

    ```


    + Response Header


    ```

    Content-Range: items 25-34/40

    ```


    ## If-Match Header

    Some APIs support the If-Match header, especially for changing data on objects. Using this, the API user can ensure that the changes are being done to the latest version.


    The APIs that support this header are:


    + **PATCH /folders**

    + **PATCH /files**


    ## Limits

    + There is a maximum length of 255 characters for project, company, folder, file, group, release, views, and clash names.

    + There is a maximum length of 40 characters for tag labels.'
  version: '2.0'
  contact:
    name: Trimble Connect Support
    url: https://connect.trimble.com
    email: connect-support@trimble.com
  license:
    name: Trimble Connect SDK Internal Use License
    url: https://developer.trimble.com/docs/connect/terms/SDK-IU-license-agreement
  termsOfService: https://developer.trimble.com/docs/connect/terms
servers:
- url: https://app.connect.trimble.com/tc/api/2.0
  description: PROD US master region
- url: https://app21.connect.trimble.com/tc/api/2.0
  description: PROD EU region
- url: https://app22.connect.trimble.com/tc/api/2.0
  description: PROD UK region
- url: https://app31.connect.trimble.com/tc/api/2.0
  description: PROD AP region
- url: https://app32.connect.trimble.com/tc/api/2.0
  description: PROD AP2 region
- url: https://app.stage.connect.trimble.com/tc/api/2.0
  description: STAGE US master region
- url: https://app31.stage.connect.trimble.com/tc/api/2.0
  description: STAGE AP region
- url: https://app21.stage.connect.trimble.com/tc/api/2.0
  description: STAGE EU region
- url: https://app.connect.trimble.com/tc/api
  description: PROD US master region (v2.1)
- url: https://app21.connect.trimble.com/tc/api
  description: PROD EU region (v2.1)
- url: https://app22.connect.trimble.com/tc/api
  description: PROD UK region (v2.1)
- url: https://app31.connect.trimble.com/tc/api
  description: PROD AP region (v2.1)
- url: https://app32.connect.trimble.com/tc/api
  description: PROD AP2 region (v2.1)
- url: https://app.stage.connect.trimble.com/tc/api
  description: STAGE US master region (v2.1)
- url: https://app31.stage.connect.trimble.com/tc/api
  description: STAGE AP region (v2.1)
- url: https://app21.stage.connect.trimble.com/tc/api
  description: STAGE EU region (v2.1)
security:
- Bearer: []
tags:
- name: Companies
  description: APIs related to Companies
paths:
  /companies:
    get:
      tags:
      - Companies
      summary: List Companies
      description: Company user can get the list of associated companies.
      operationId: ListCompanies
      deprecated: true
      parameters: []
      responses:
        '206':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyDetailsResponse'
                description: ''
                example:
                - id: kTjLp5b2VQM
                  name: Trimble
                  website: www.trimble.com
                  domains:
                  - trimble.com
                  image: http://{baseUrl}/tc/app/files/thumb?id=Dyfw481f264&fc=COMPANYIMG#?429259527000
                  role: ADMIN
                  createdOn: 2016-02-09T17:49:19-0800
                  modifiedOn: 2016-02-09T17:49:49-0800
                  createdBy:
                    id: Dyfw481f265
                    firstName: John
                    lastName: Doe
                    email: jdoe@trimble.com
                    status: ACTIVE
                  modifiedBy:
                    id: Dyfw481f266
                    firstName: John
                    lastName: Doe
                    email: jdoe@trimble.com
                    status: ACTIVE
                - id: q-XKNAhg3Rk
                  name: Google
                  website: www.google.com
                  domains:
                  - google.com
                  image: http://{baseUrl}/tc/app/files/thumb?id=Dyfw481f267&fc=COMPANYIMG#?429259527000
                  role: USER
                  createdOn: 2016-02-09T17:49:19-0800
                  modifiedOn: 2016-02-09T17:49:49-0800
                  createdBy:
                    id: Dyfw481f268
                    firstName: John
                    lastName: Doe
                    email: jdoe@trimble.com
                    status: ACTIVE
                  modifiedBy:
                    id: Dyfw481f269
                    firstName: John
                    lastName: Doe
                    email: jdoe@trimble.com
                    status: ACTIVE
  /companies/{companyId}:
    get:
      tags:
      - Companies
      summary: Get Company Details
      description: API for company user/admin to get details of a company.
      operationId: GetCompanyDetails
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: ID of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDetailsResponse'
    patch:
      tags:
      - Companies
      summary: Update Company
      description: The company admin can update the company name, website and domains of the company.
      operationId: UpdateCompany
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: Id of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCompanyRequest'
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDetailsResponse'
  /companies/{companyId}/domains:
    patch:
      tags:
      - Companies
      summary: Add Company Email Domains
      description: The company admin can update the company email domains. The entries will append to the existing domains.
      operationId: AddCompanyEmailDomains
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: Id of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
              description: ''
              example:
              - trimble.co.in
            example:
            - trimble.co.in
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: ''
                example:
                - trimble.com
                - trimble.co.in
              example:
              - trimble.com
              - trimble.co.in
    delete:
      tags:
      - Companies
      summary: Remove Company Email Domains
      description: API for company admin to remove email domains from company.
      operationId: RemoveCompanyEmailDomains
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: Id of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      responses:
        '204':
          description: ''
          headers: {}
  /companies/{companyId}/image:
    post:
      tags:
      - Companies
      summary: Upload Company Image
      description: API for company admin to update the company logo by uploading an image file.
      operationId: UploadCompanyImage
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: ID of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      requestBody:
        description: ''
        content:
          text/plain:
            schema:
              type: string
              example: + The image file to be uploaded.
            example: + The image file to be uploaded.
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDetailsResponse'
  /companies/{companyId}/users:
    get:
      tags:
      - Companies
      summary: List Users in a Company
      description: API for company user/admin to list users in the company.
      operationId: ListUsersinaCompany
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: ID of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      responses:
        '206':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserDetailsResponse'
                description: ''
    post:
      tags:
      - Companies
      summary: Add Users to Company
      description: API for company admin to add users to the company.
      operationId: AddUserstoCompany
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: ID of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AddUserstoCompanyRequest'
              description: ''
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserDetailsResponse'
                description: ''
    delete:
      tags:
      - Companies
      summary: Remove Users from Company
      description: API for company admin to remove users from the company.
      operationId: RemoveUsersfromCompany
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: ID of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      responses:
        '204':
          description: ''
          headers: {}
  /companies/{companyId}/users/{userId}:
    patch:
      tags:
      - Companies
      summary: Update User in the Company
      description: API to change the role of the user in the company.
      operationId: UpdateUserintheCompany
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: ID of the company
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      - name: userId
        in: path
        description: ID of the user
        required: true
        schema:
          type: string
          example: vaItzxo0oIw
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserintheCompanyRequest'
            example:
              role: USER
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailsResponse'
    delete:
      tags:
      - Companies
      summary: Remove User from the Company
      description: API for company admin to remove the specified user from the company.
      operationId: RemoveUserfromtheCompany
      deprecated: true
      parameters:
      - name: companyId
        in: path
        description: ID of the company.
        required: true
        schema:
          type: string
          example: kTjLp5b2VQM
      - name: userId
        in: path
        description: ID of the user to be removed.
        required: true
        schema:
          type: string
          example: vaItzxo0oIw
      responses:
        '204':
          description: ''
          headers: {}
components:
  schemas:
    CompanyDetailsResponse:
      title: CompanyDetailsResponse
      required:
      - id
      - name
      - website
      - domains
      - image
      - role
      - createdOn
      - modifiedOn
      - createdBy
      - modifiedBy
      type: object
      properties:
        id:
          type: string
          description: Company identifier
        name:
          type: string
          description: Name of the company
        website:
          type: string
          description: Website of the company
        domains:
          type: array
          items:
            type: string
          description: domains of the company
        image:
          type: string
          description: URL to fetch the thumbnail of the Company Logo (if exists)
        role:
          type: string
          description: Role of the current user in the company
        createdOn:
          type: string
          description: (timestamp)An ISO8601 date when the Company was created
        modifiedOn:
          type: string
          description: (timestamp)An ISO8601 date when the Company was last modified
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
      example:
        id: kTjLp5b2VQM
        name: Trimble
        website: www.trimble.com
        domains:
        - trimble.com
        image: http://{baseUrl}/tc/app/files/thumb?id=Dyfw481f366&fc=COMPANYIMG#?429259527000
        role: ADMIN
        createdOn: 2016-02-09T17:49:19-0800
        modifiedOn: 2016-02-09T17:49:49-0800
        createdBy:
          id: Dyfw481f367
          firstName: John
          lastName: Doe
          email: jdoe@trimble.com
          status: ACTIVE
        modifiedBy:
          id: Dyfw481f368
          firstName: John
          lastName: Doe
          email: jdoe@trimble.com
          status: ACTIVE
    UserDetailsResponse:
      title: UserDetailsResponse
      required:
      - id
      - email
      - hasImage
      - status
      - timeZone
      - language
      - role
      - createdOn
      - modifiedOn
      type: object
      properties:
        id:
          type: string
          description: User identifier
        tiduuid:
          type: string
          description: Trimble ID of the user
        firstName:
          type: string
          description: First name of the user
        lastName:
          type: string
          description: Last name of the user
        email:
          type: string
          description: Email of the user
        status:
          type: string
          description: User status. User's status is PENDING when a new user has been invited to a project and has not access Connect yet. Once the user has accessed Connect, the status becomes ACTIVE. REMOVED is a project specific status that is shown for users that have been removed from a project.
          enum:
          - ACTIVE
          - PENDING
          - REMOVED
        viewerBackground:
          $ref: '#/components/schemas/ViewerBackground'
        timeZone:
          type: string
          description: Timezone preference of the user
        title:
          type: string
          description: Title for the user
        skypeId:
          type: string
          description: SkypeId of the user
        linkedinId:
          type: string
          description: LinkedinId preference of the user
        phone:
          type: string
          description: phone number of the user
        podLocation:
          type: string
          description: podLocation of the user
        hasImage:
          type: boolean
          description: Image of the user
        thumbnail:
          type: string
          description: URL to fetch the thumbnail of the user (if exists)
        language:
          type: string
          description: Language preference of the user
        role:
          type: string
          description: Role of user (applicable only in context of a project)
        company:
          $ref: '#/components/schemas/Company'
        companies:
          type: array
          items:
            $ref: '#/components/schemas/Company'
        createdOn:
          type: string
          description: (timestamp) An ISO8601 date when the user was created
        modifiedOn:
          type: string
          description: (timestamp) An ISO8601 date when the user was modified
        lastAccessed:
          type: string
          description: (timestamp)  An ISO8601 date when the user was lastAccessed
        companyAdmin:
          type: boolean
      example:
        id: LWOf7rirztM
        firstName: John
        lastName: Doe
        email: jdoe@trimble.com
        status: ACTIVE
        timeZone: (UTC-08:00) Pacific Time (US & Canada)
        thumbnail: https://{baseURL}/tc/app/files/thumb?id=RQd6YBZ8Gds&fc=USERIMG&modified=1481050888000
        language: English
        hasImage: false
        role: ADMIN
        companies:
        - id: k-PEcTYK268
          name: Trimble.com
          website: gmail.com
          image: https://{baseURL}/tc/app/files/thumb?id=k-PEcTYK269&fc=COMPANYIMG#?1487053557000
          createdOn: 2017-01-18T12:48:38+0000
          role: ADMIN
          modifiedOn: 2017-02-14T06:25:57+0000
          createdBy:
            id: Dyfw481f382
            firstName: John
            lastName: Doe
            email: jdoe@trimble.com
            status: ACTIVE
          modifiedBy:
            id: Dyfw481f383
            firstName: John
            lastName: Doe
            email: jdoe@trimble.com
            status: ACTIVE
        - id: JaWS7gc_rdk
          name: Trimble test
          website: trimbletest.com
          image: /tc/ng-static/styles/img/trimbleconnect_header.svg
          createdOn: 2017-01-28T17:44:10+0000
          role: USER
          modifiedOn: 2017-02-09T08:37:02+0000
          createdBy:
            id: Dyfw481f384
            firstName: support
            lastName: tc
            email: support@trimble.com
            status: ACTIVE
          modifiedBy:
            id: Dyfw481f385
            firstName: support
            lastName: tc
            email: support@trimble.com
            status: ACTIVE
        createdOn: 2016-07-12T23:14:31+0000
        modifiedOn: 2016-10-27T22:09:16+0000
    UpdateUserintheCompanyRequest:
      title: UpdateUserintheCompanyRequest
      required:
      - role
      type: object
      properties:
        role:
          type: string
          enum:
          - ADMIN
          - USER
          description: Role of the User in the company
      example:
        role: USER
    Company:
      title: Company
      required:
      - name
      - website
      - image
      - role
      - createdOn
      - modifiedOn
      - createdBy
      - modifiedBy
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        website:
          type: string
        image:
          type: string
        role:
          type: string
        createdOn:
          type: string
        modifiedOn:
          type: string
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
      example:
        name: Trimble.com
        website: gmail.com
        image: https://{baseURL}/tc/app/files/thumb?id=k-PEcTYK265&fc=COMPANYIMG#?1487053557000
        role: ADMIN
        createdOn: 2017-01-18T12:48:38+0000
        modifiedOn: 2017-02-14T06:25:57+0000
        createdBy:
          firstName: John
          lastName: Doe
          email: jdoe@trimble.com
          status: ACTIVE
        modifiedBy:
          firstName: John
          lastName: Doe
          email: jdoe@trimble.com
          status: ACTIVE
    UpdateCompanyRequest:
      title: UpdateCompanyRequest
      type: object
      properties:
        name:
          type: string
          description: name of the company
        website:
          type: string
          description: Website of the company
        domains:
          type: array
          items:
            type: string
          description: Domains of the company. The entries will replace the existing domains. Empty array will delete all domains.
      example:
        name: Trimble
        website: www.trimble.com
        domains:
        - trimble.com
        - trimble.co.in
    ViewerBackground:
      title: ViewerBackground
      required:
      - r
      - g
      - b
      - a
      type: object
      properties:
        r:
          type: number
          description: Red component 0…255
        g:
          type: number
          description: Green component
        b:
          type: number
          description: Blue component
        a:
          type: number
          description: Alpha component
      example:
        r: 20
        g: 40
        b: 50
        a: 10
    AddUserstoCompanyRequest:
      title: AddUserstoCompanyRequest
      type: object
      properties:
        id:
          type: string
          description: ID of the User. Optional if email is present, else required.
        email:
          type: string
          description: Email of the User. Optional if id is present, else required.
        role:
          type: string
          enum:
          - ADMIN
          - USER
          description: Role of the User in the company (default value is USER)
      example:
        id: vaItzxo0oIw
    CreatedBy:
      title: CreatedBy
      required:
      - id
      - firstName
      - lastName
      - email
      - status
      type: object
      description: User details of who created this object
      properties:
        id:
          type: string
          description: User identifier
        tiduuid:
          type: string
          description: Trimble ID of the user
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        status:
          type: string
          description: User status. User's status is PENDING when a new user has been invited to a project and has not access Connect yet. Once the user has accessed Connect, the status becomes ACTIVE. REMOVED is a project specific status that is shown for users that have been removed from a project.
          enum:
          - ACTIVE
          - PENDING
          - REMOVED
        company:
          $ref: '#/components/schemas/Company'
        companies:
          type: array
          items:
            $ref: '#/components/schemas/Company'
        companyAdmin:
          type: boolean
      example:
        id: LWOf7rirztM
        tiduuid: b75d4e5c-e4c0-4a92-9963-fcc5d36dd6a6
        firstName: John
        lastName: Doe
        email: jdoe@trimble.com
        status: ACTIVE
    ModifiedBy:
      title: ModifiedBy
      required:
      - id
      - firstName
      - lastName
      - email
      - status
      type: object
      description: User details of who modified this object recently
      properties:
        id:
          type: string
          description: User identifier
        tiduuid:
          type: string
          description: Trimble ID of the user
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        status:
          type: string
          description: User status. User's status is PENDING when a new user has been invited to a project and has not access Connect yet. Once the user has accessed Connect, the status becomes ACTIVE. REMOVED is a project specific status that is shown for users that have been removed from a project.
          enum:
          - ACTIVE
          - PENDING
          - REMOVED
      example:
        id: LWOf7rirztM
        tiduuid: b75d4e5c-e4c0-4a92-9963-fcc5d36dd6a6
        firstName: John
        lastName: Doe
        email: jdoe@trimble.com
        status: ACTIVE
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT