Trimble Clashes API

APIs related to Clashes TC supports max length of 255 characters for clash names. Names are validated according to OS supported rules, so ones that contain non-printable ascii or with special meaning will be rejected by the API (Ex: "..", "PRN", "/")

GitHub OpenAPI

Operations 6

GET /clashsets List all Clashes in a project #
POST /clashsets Create a New Clash #
GET /clashsets/{clashId} Get Clash Details #
PATCH /clashsets/{clashId} Update Clash #
DELETE /clashsets/{clashId} Delete a Clash #
GET /clashsets/{clashId}/items List All Clash Items #

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-clashes-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-clashes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Clashes 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: Clashes
  description: 'APIs related to Clashes

    TC supports max length of 255 characters for clash names. Names are validated according to OS supported rules, so ones that contain non-printable ascii or with special meaning will be rejected by the API (Ex: "..", "PRN", "/")'
paths:
  /clashsets:
    get:
      tags:
      - Clashes
      summary: List all Clashes in a project
      operationId: ListallClashesinaproject
      parameters:
      - name: projectId
        in: query
        description: ID of the project.
        required: true
        schema:
          type: string
          example: uIWwVwIss4k
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClashDetailsResponse'
    post:
      tags:
      - Clashes
      summary: Create a New Clash
      description: You can create a new Clash Report using this action.
      operationId: CreateaNewClash
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClashRequest'
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClashDetailsResponse'
  /clashsets/{clashId}:
    get:
      tags:
      - Clashes
      summary: Get Clash Details
      operationId: GetClashDetails
      parameters:
      - name: clashId
        in: path
        description: ID of the Clash
        required: true
        schema:
          type: string
          example: bCiE0H8vE38
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClashDetailsResponse'
    patch:
      tags:
      - Clashes
      summary: Update Clash
      description: 'This API allows you to update the following properties of the Clash:


        - name


        - assignees'
      operationId: UpdateClash
      parameters:
      - name: clashId
        in: path
        description: ID of the Clash
        required: true
        schema:
          type: string
          example: bCiE0H8vE38
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClashRequest'
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClashDetailsResponse'
    delete:
      tags:
      - Clashes
      summary: Delete a Clash
      operationId: DeleteClash
      parameters:
      - name: clashId
        in: path
        description: ID of the Clash
        required: true
        schema:
          type: string
          example: bCiE0H8vE38
      responses:
        '204':
          description: ''
          headers: {}
  /clashsets/{clashId}/items:
    get:
      tags:
      - Clashes
      summary: List All Clash Items
      description: 'This API returns a list of clash-items in the Clash.

        **Note** : The center point will not be present for clash-items of legacy viewer based clashsets.'
      operationId: ListAllClashItems
      parameters:
      - name: clashId
        in: path
        description: ID of the Clash
        required: true
        schema:
          type: string
          example: bCiE0H8vE38
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListAllClashItemsResponse'
                description: ''
components:
  schemas:
    ClashItemSourceId:
      title: ClashItemSourceId
      required:
      - sourceId
      - versionId
      type: object
      description: source id of first element
      properties:
        sourceId:
          type: string
          description: The source id
        versionId:
          type: string
          description: The file version of the source
      example:
        sourceId: 0n7sI9iqr1AQjcef7_fZGD
        versionId: QQrLmjOjRoY
    ClashDetailsResponse:
      title: ClashDetailsResponse
      required:
      - name
      - id
      - projectId
      - tolerance
      - type
      - status
      - count
      - ignoreSameDiscipline
      - models
      - files
      - createdBy
      - createdOn
      - modifiedBy
      - modifiedOn
      type: object
      properties:
        id:
          type: string
          description: Clash identifier
        name:
          type: string
          description: name for the Clash
        projectId:
          type: string
          description: project identifier
        tolerance:
          type: number
          description: (float)- Tolerance of the clash
        type:
          type: string
          enum:
          - CLASH
          - CLEARANCE
          description: Type of Clash report created
        status:
          type: number
          description: (Int)- Clash processing indicator
        count:
          type: number
          description: count of clash
        ignoreSameDiscipline:
          type: boolean
          description: (Int)-  Flag check to ignore same discipline in Clash
        models:
          type: array
          items:
            type: string
          description: An ordered array of model version ids
        files:
          type: array
          items:
            type: string
          description: An ordered array of model file ids corresponding to the models array
        assignees:
          $ref: '#/components/schemas/AssigneeResponse'
        modifiedOn:
          type: string
          description: (timestamp) - An ISO8601 date when the Clash was last modified
        createdOn:
          type: string
          description: (timestamp) - An ISO8601 date when the Clash was last modified
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
      example:
        name: mashup2
        projectId: Dyfw481f438
        status: 100
        tolerance: 0.01
        type: CLASH
        count: 8
        id: bCiE0H8vE38
        ignoreSameDiscipline: false
        models:
        - baYVC8V3ag8
        files:
        - baYVC8V3ag8
        createdBy:
          id: Dyfw481f439
          firstName: Johny
          lastName: Doe
          email: johndoe@trimble.com
          status: ACTIVE
        createdOn: 2015-01-21T16:06:09-0800
        modifiedBy:
          id: Dyfw481f440
          firstName: Johny
          lastName: Doe
          email: johndoe@trimble.com
          status: ACTIVE
        modifiedOn: 2015-01-21T16:06:09-0800
    AssigneeResponse:
      title: AssigneeResponse
      required:
      - id
      - type
      - firstName
      - lastName
      - name
      - email
      type: object
      description: Assignee are the users who got assigned with some task
      properties:
        id:
          type: string
          description: User identifier
        tiduuid:
          type: string
          description: Trimble ID of the user
        type:
          type: string
          enum:
          - USER
          - GROUP
          description: Type of assignee
        firstName:
          type: string
        lastName:
          type: string
        name:
          type: string
        email:
          type: string
      example:
        id: Dyfw481f431
        tiduuid: b4581f50-1e6c-4ccd-8a6c-af2ac07b31a6
        type: USER
        firstName: John
        lastName: Doe
        email: JDoe@trimble.com
        name: John Doe
    AssigneesRequest:
      title: AssigneesRequest
      required:
      - id
      - type
      type: object
      description: List of users or groups assigned to ToDo.
      properties:
        id:
          type: string
          description: Id of the user
        type:
          type: string
          enum:
          - USER
          - GROUP
          description: Type of assignee
      example:
        id: woC32em2Fb0
        type: 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
    ListAllClashItemsResponse:
      title: ListAllClashItemsResponse
      required:
      - id
      - label
      - distance
      - sourceId1
      - sourceId2
      - elementName1
      - elementName2
      - elementType1
      - elementType2
      - center
      type: object
      properties:
        id:
          type: string
          description: clash item identifier
        label:
          type: string
          description: clash item name
        distance:
          type: number
          description: (float)-penetration distance or clearance distance
        sourceId1:
          $ref: '#/components/schemas/ClashItemSourceId'
        sourceId2:
          $ref: '#/components/schemas/ClashItemSourceId'
        elementName1:
          type: string
          description: name of the first object
        elementName2:
          type: string
          description: name of the second object
        elementType1:
          type: string
          description: Type of the first object
        elementType2:
          type: string
          description: Type of the second object
        center:
          $ref: '#/components/schemas/ClashItemCenter'
      example:
        id: 9Ssi8I0CcG4
        label: TRBT-1
        distance: -160
        sourceId1:
          sourceId: 0n7sI9iqr1AQjcef7_fZGD
          versionId: QQrLmjOjRoY
        sourceId2:
          sourceId: 3RkoOjmuLBFO0Wb70dNZur
          versionId: QQrLmjOjRoY
        elementName1: W010
        elementName2: C001
        elementType1: IFCWALLSTANDARDCASE
        elementType2: IFCCOLUMN
        center:
          x: 7000
          y: 18920
          z: 4854
    CreateClashRequest:
      title: CreateClashRequest
      required:
      - name
      - tolerance
      - type
      - ignoreSameDiscipline
      - models
      type: object
      properties:
        name:
          type: string
          description: name for the Clash
        tolerance:
          type: number
          description: (float)- Tolerance of the clash
        type:
          type: string
          enum:
          - CLASH
          - CLEARANCE
          description: Type of Clash report created
        ignoreSameDiscipline:
          type: boolean
          description: (Int)-  Flag check to ignore same discipline in Clash
        models:
          type: array
          items:
            type: string
          description: An ordered array of model version ids
      example:
        name: mashup2
        type: CLASH
        tolerance: 0.01
        ignoreSameDiscipline: false
        models:
        - baYVC8V3ag8
    UpdateClashRequest:
      title: UpdateClashRequest
      type: object
      properties:
        assignees:
          type: array
          items:
            $ref: '#/components/schemas/AssigneesRequest'
          description: ''
        name:
          type: string
      example:
        assignees:
        - id: Dyfw481f441
          type: USER
        - id: EdLprWxy9Xw
          type: GROUP
    ClashItemCenter:
      title: ClashItemCenter
      required:
      - x
      - y
      - z
      type: object
      description: center point to represent the clash-item
      properties:
        x:
          type: number
          description: x coordinate
        y:
          type: number
          description: y coordinate
        z:
          type: number
          description: z coordinate
      example:
        x: 7000
        y: 18920
        z: 4854
    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