Trimble Object Sync API

APIs related to synchronizing objects state with local storages and caches

GitHub OpenAPI

Operations 2

GET /projects/{projectId}/objects Get project content changes since last time #
GET /projects/{projectId}/status Get project content sync cursor #

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-object-sync-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-object-sync-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Object Sync 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: Object Sync
  description: APIs related to synchronizing objects state with local storages and caches
paths:
  /projects/{projectId}/objects:
    get:
      tags:
      - Object Sync
      summary: Get project content changes since last time
      description: 'Fetch the changes in the project content happend after the sync cursor value proved in the `status` parameter.

        The API allows to fetch changes in project files and folders. Each change represents a new version of the file or folder. Changes are ordered by the time. The API can be thought of as a stream of change events, client fetches events from the stream using a cursor (skipToken) that represents a position in the stream. If skipToken is not provided then events are fetched from the beginning of the project history, otherwise only events that happen after the given cursor are returned. The API allows to implement efficient incremental synchronisation (or cache invalidation) for the project file system on the client side.'
      operationId: GetProjectSyncObjects
      parameters:
      - name: projectId
        in: path
        description: Id of the project to process
        required: true
        schema:
          type: string
          example: vGxx_WPD1G0
      - name: status
        in: query
        description: The base64 url-safe encoded for of sync cursor from the `GetProjectSyncStatus` API.
        required: true
        schema:
          type: string
          example: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NTY4ODY4MjUsInN1YiI6IlFRckxtak9qUm9ZIiwidXNlcklkIjoiTS1kV3VqSk5RWEEiLCJpc3MiOiInYXBpLmd0ZWFtLmNvbSciLCJqdGkiOiIxbl8wclV4aWUydyIsInNJZCI6Im1Nd1VadTNwZmNNIiwiaWF0IjoxNDU2ODU4MDI1fQ.7nTSr6Apzu0JeN7-_bl58fDyZ32Q_lL-uTK1wIOFQWg
      - name: types
        in: query
        description: 'Comma seperated resource types to fetch. Supported types are: [`ALIGNMENT`,`CLASH`,`COMMENT`,`GROUP`,`FSOBJECT`(_Supported for `FILE` and `FOLDER` types_),`OBJECTLINK`,`RELEASE`,`TAG`,`TODO`,`VIEW`,`VIEW2D`,`VIEW_GROUP`]. If not provided, all supported object types are included.'
        schema:
          type: string
          example: TODO,COMMENT,TAG
      - name: includeTopicEmbedded
        in: query
        description: If specified and true then topic embedded views will be included in the response
        schema:
          type: boolean
          default: false
      - name: format
        in: query
        description: Format to be used in the response. Possible values are (**`v1, v2`**). <br/>Default value is v1. This format will be deprecated soon. <br/>Format **`v1`** follows legacy response structure (refer ObjectSyncFetchObjects). <br/>Format **`v2`** follows new response structure (refer FileFolderObjSyncResponse).
        required: false
        schema:
          type: string
          default: v1
      - name: skipToken
        in: query
        description: 'Optimized cursor to fetch events. **`skipToken`** represents a position in the stream. <br/>If not provided, events are fetched from the beginning of the project history. '
        required: false
        schema:
          type: string
      - name: Range
        in: header
        description: Pagination details for legacy implementation. <br/>It is recommended to use **`format=v2`**, **`skipToken`** and **`maxItems`** for **`types=FSOBJECT`** workflow.
        required: false
        schema:
          type: string
      - name: maxItems
        in: query
        description: Maximum amount of items to return in the response. <br/>It is not guaranteed that exact number of items will be returned, but up to the provided value as max. <br/>The maximum value for this parameter is **`10000`** and the default value will be same as the maximum value. <br/> If requested maxItems exceeds the limit (**10000**), then request will be failed with an error message. <br/>Note that max items limit might be increased in the future, clients should not make any assumptions on the number of items returned by default.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ObjectSyncFetchObjectList'
                - $ref: '#/components/schemas/FileFolderObjSyncResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /projects/{projectId}/status:
    get:
      tags:
      - Object Sync
      summary: Get project content sync cursor
      description: Returns the project content sync cursor. This sync cursor is exected to be used together with the `ObjectSync` API to detect changes in the project content and do the incremental sync.
      operationId: GetProjectSyncStatus
      parameters:
      - name: projectId
        in: path
        description: Id of the project to process
        required: true
        schema:
          type: string
          example: vGxx_WPD1G0
      - name: encode
        in: query
        description: If false sync cursors for individual resource types are returned, otherwise a full encoded project sync cursor is returned. A full encoded project cursor is base64 encoded json object with all individual sync cursors.
        schema:
          type: boolean
          default: true
      - name: If-Modified-Since
        in: header
        schema:
          type: string
          format: timestamp
          example: Fri, 20 Nov 2015 20:07:45 GMT
      responses:
        '200':
          description: The the project content sync cursor. If `encode` query parameter is `true` or missing only the `status` property is returned, otherwise response contains all individual sync cursors for all resource types. Content of individual resource cursors should not be interpreted by client in any way and used as an opaque string for equality operations only.
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    description: Base64 url-safe encoded string representing the current state of the project content. Only this property is returned if encode query parameter is true or missing.
                    example: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NTY4ODY4MjUsInN1YiI6IlFRckxtak9qUm9ZIiwidXNlcklkIjoiTS1kV3VqSk5RWEEiLCJpc3MiOiInYXBpLmd0ZWFtLmNvbSciLCJqdGkiOiIxbl8wclV4aWUydyIsInNJZCI6Im1Nd1VadTNwZmNNIiwiaWF0IjoxNDU2ODU4MDI1fQ.7nTSr6Apzu0JeN7-_bl58fDyZ32Q_lL-uTK1wIOFQWg
                  projectId:
                    type: string
                    description: The project identifier.
                  modifiedOn:
                    type: string
                    description: The time of latest change in the project content.
                  projectMetadataTs:
                    type: string
                    description: The project descriptor sync cursor value.
                  teamTs:
                    type: string
                    description: The project members sync cursor value.
                  groupsTs:
                    type: string
                    description: The user groups sync cursor value.
                  filesTs:
                    type: string
                    deprecated: true
                    description: The files sync cursor value.
                  foldersTs:
                    type: string
                    deprecated: true
                    description: The folders sync cursor value.
                  fsobjTs:
                    type: string
                    description: The combined files and folders sync cursor value.
                  alignmentTs:
                    type: string
                    description: The model alignments sync cursor value.
                  thumbnailTs:
                    type: string
                    description: The thumbnails sync cursor value.
                  permissionsTs:
                    type: string
                    description: The file permissions sync cursor value.
                  commentsTs:
                    type: string
                    description: The comments sync cursor value.
                  tagTs:
                    type: string
                    description: The tags sync cursor value.
                  todosTs:
                    type: string
                    description: The todos sync cursor value.
                  releasesTs:
                    type: string
                    description: The releases sync cursor value.
                  clashesTs:
                    type: string
                    description: The clashes sync cursor value.
                  viewsTs:
                    type: string
                    description: The 3D views sync cursor value.
                  views2dTs:
                    type: string
                    description: The 2D views sync cursor value.
                  viewGroupsTs:
                    type: string
                    description: The 2D views sync cursor value.
                  objectlinkTs:
                    type: string
                    description: The object links sync cursor value.
components:
  schemas:
    ObjectSyncFetchObjects:
      title: List of objects from the object sync
      required:
      - type
      - status
      - objects
      type: object
      properties:
        type:
          type: string
          description: the object type
        status:
          type: number
          description: the new cursor value for subsequent fetches
        range:
          type: string
          example: items 0-1/2
          description: if Response is paged information about the current page is returned
        objects:
          type: array
          description: the objects changed or created
          items:
            type: object
            description: schema corresponds on the object type
    FileFolderItem:
      type: object
      properties:
        id:
          type: string
          description: ID
        vid:
          type: string
          description: Version ID
        nm:
          type: string
          description: Name
        pid:
          type: string
          description: Parent ID
        ptp:
          type: string
          description: Parent Type
        tp:
          type: string
          description: Type
        ct:
          type: string
          description: Created
          format: date-time
        mt:
          type: string
          description: Modified
          format: date-time
        cid:
          type: string
          description: Created By
        mid:
          type: string
          description: Modified By
        sz:
          type: integer
          description: Size
          format: int64
        del:
          type: boolean
          description: Deleted
        tn:
          type: string
          description: Thumbnail
        md5:
          type: string
          description: MD5/Hash
        chid:
          type: string
          description: Checkout by
        cht:
          type: string
          description: Checkout time
          format: date-time
        rv:
          type: integer
          description: Revision
          format: int64
        ra:
          type: string
          description: Read Access list with actor type and id
        fa:
          type: string
          description: Full Access list with actor type and id
        dat:
          type: string
          description: Default access type
        ac:
          type: array
          description: Actions
          items:
            type: string
            description: Actions
        inh:
          type: boolean
          description: Inheritance
      description: List of file/folder details
    FileFolderObjSyncResponse:
      type: object
      properties:
        items:
          type: array
          description: List of file/folder details
          items:
            $ref: '#/components/schemas/FileFolderItem'
        next:
          type: string
          description: Responses that include only a partial set of the items identified by the request will contain a link that allows retrieving the next partial set of items. <br/>This link is called a next link. Clients should treat the URL of the next link as opaque, and should not append system query options to the URL of a next link. <br/>The url returned by server might be an absolute url or path with query parameters. <br/>If it is a path, client is responsible for adding a hostname to form a full url. <br/>Otherwise no transformations must be applied by client to the url and it should be sent as is to the server to fetch next page of items.
        type:
          type: string
          description: Type of the stream. In this case, FSOBJECT
    ObjectSyncFetchObjectList:
      type: array
      items:
        $ref: '#/components/schemas/ObjectSyncFetchObjects'
      example:
      - type: FOLDER
        status: 1454976660000
        objects: []
      - type: RELEASE
        status: 1454976586000
        objects: []
      - type: CLASH
        status: 1454976586000
        objects: []
      - type: FILE
        status: 1454977116000
        objects: []
      - type: COMMENT
        status: 1454976586000
        objects: []
      - type: SNAPSHOT
        status: 1454976586000
        objects: []
      - range: items 0-1/2
        type: TODO
        status: 1455041601000
        objects:
        - id: aFclSsrUbrg
          label: EEWE-1
          description: rererre
          status: NEW
          priority: NORMAL
          projectId: m25qYc1o9Hc
          attachements: []
          createdBy:
            id: Dyfw481f360
            firstName: imti
            lastName: s
            email: imti@gt-global.com
            status: ACTIVE
          modifiedBy:
            id: Dyfw481f361
            firstName: imti
            lastName: s
            email: imti@gt-global.com
            status: ACTIVE
          createdOn: 2016-02-09T10:12:42-0800
          modifiedOn: 2016-02-09T10:12:42-0800
        - id: CyMqTf73C-E
          label: EEWE-2
          description: ferefr
          status: NEW
          priority: NORMAL
          projectId: m25qYc1o9Hc
          attachements: []
          createdBy:
            id: Dyfw481f362
            firstName: imti
            lastName: s
            email: imti@gt-global.com
            status: ACTIVE
          modifiedBy:
            id: Dyfw481f363
            firstName: imti
            lastName: s
            email: imti@gt-global.com
            status: ACTIVE
          createdOn: 2016-02-09T10:13:21-0800
          modifiedOn: 2016-02-09T10:13:21-0800
      - type: GROUP
        status: 1454976586000
        objects: []
      - type: VIEW2D
        status: 1454976586000
        objects: []
      - range: items 0-0/1
        type: TAG
        status: 1454976586000
        objects:
        - id: nHAnBhUILMg
          projectId: M6yRLfIM8hQ
          label: Architecture
          description: Architecture
          createdOn: 2016-02-09T10:13:21-0800
          createdBy:
            id: Dyfw481f364
            firstName: John
            lastName: Doe
            email: johndoe@gt-global.com
            status: ACTIVE
          modifiedOn: 2016-02-09T10:13:21-0800
          modifiedBy:
            id: Dyfw481f365
            firstName: John
            lastName: Doe
            email: johndoe@gt-global.com
            status: ACTIVE
    ApiError:
      type: object
      properties:
        message:
          type: string
        details:
          type: string
        errorcode:
          type: string
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT