Trimble Activities API

APIs related to Activities

GitHub OpenAPI

Operations 6

GET /activities List Activities of a Project / Object #
POST /activities/exports Create a new export Request #
GET /activities/exports/{exportId} Get export details #
POST /activities/list List activities with filters #
GET /activities/{activityId} Activity Details by activityId #
GET /activities/{activityId}/logs Activity logs by activityId #

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-activities-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-activities-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Activities 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: Activities
  description: APIs related to Activities
paths:
  /activities:
    get:
      tags:
      - Activities
      summary: List Activities of a Project / Object
      description: API to list the activities in a project / specific object
      operationId: ListActivitiesofaProject/Object
      parameters:
      - name: projectId
        in: query
        description: ID of the Project, if present lists all activities with in the project. Optional if objectId is present, else required
        required: true
        schema:
          type: string
          example: woC32em2Fb0
      - name: objectId
        in: query
        description: ID of the Object, if present lists all activities associated with the object. Optional if projectId is present, else required.
        schema:
          type: string
          example: q-XKNAhg3Rk
      - name: objectType
        in: query
        description: 'objectType  of `objectId`. **If objectId is specified, objectType  is required**. (Supported values : `PROJECT`, `VIEW`, `CLASH`, `RELEASE`, `COMMENT`, `FOLDER`, `FILE`, `TODO`, `VIEW2D`, `USER`)'
        schema:
          type: string
          example: RELEASE
      - name: filters
        in: query
        description: It supports either comma separated objectTypes or a single objectType as input and would return the related activities of the specified objectType. Query param should be either filters or a combination of objectId and objectType. Both filters and a combination of objectId and objectType cannot be provided via a single request. When a single objectType(`FILE`) is provided, activities related to `FILE` objectType would be returned. When multiple comma separated objectType's(`FILE,FOLDER,TODO`) are provided, activities related to `FILE`,`FOLDER` and `TODO` would be returned.
        schema:
          type: string
        examples:
          singleObjectType:
            value: FILE
          multipleObjectType:
            value: FILE,FOLDER,TODO
      - name: lastId
        in: query
        description: Activity Id, if it is passed the api collects the list of activities next to the given activity id
        schema:
          type: string
          example: zIn1S6j0yww
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActivityDetailsResponse'
  /activities/exports:
    post:
      tags:
      - Activities
      summary: Create a new export Request
      description: This API is used to create export Request for activities in a project.
      operationId: PostCreateanewexportRequest
      parameters:
      - name: projectId
        in: query
        description: Project ID for which the details are required.
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNewExportRequest'
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityExportDetails'
              example:
                id: tJ2lDVMEiOY
                projectId: MmpytDCiOQM
                status: PENDING
                filters:
                - FILE
                - FOLDER
                users:
                - 1rNbvWZv265
                - Du0rV40exHk
                groups:
                - 1rNbvWZv266
                - Du0rV40exHk
                fromDate: 2017-05-05T00:00:00+0000
                toDate: 2017-05-09T00:00:00+0000
  /activities/exports/{exportId}:
    get:
      tags:
      - Activities
      summary: Get export details
      description: API to fetch details of the export activities.
      operationId: GetExportdetails
      parameters:
      - name: exportId
        in: path
        description: Export ID for which the details are required.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityExportDetails'
              example:
                id: tJ2lDVMEiOY
                projectId: MmpytDCiOQM
                status: PENDING
                downloadUrl: http://app.connect.trimble.com:8081/tc/api/2.0/excel/0CGhTWXE3A4
                filters:
                - FILE
                - FOLDER
                users:
                - 1rNbvWZv267
                - Du0rV40exHk
                groups:
                - 1rNbvWZv268
                - Du0rV40exHk
                fromDate: 2017-05-05T00:00:00+0000
                toDate: 2017-05-09T00:00:00+0000
  /activities/list:
    post:
      tags:
      - Activities
      summary: List activities with filters
      description: 'This API is used to list activities with filters.The `filters` in the request body can be used to filter the list of activities by a start and end date, by list of users or usergroups who performed actions that created the activities, and by list of activity types.

        This API can also be used to list activities by specific objectId and objectType by using the query parameters.

        This API uses cursor based pagination (see `lastId` and `pageSize` query params) and does not support range headers.'
      parameters:
      - name: objectId
        in: query
        description: ID of the Object, if present lists all activities associated with the object. Optional if projectId is present, else required.
        schema:
          type: string
          example: q-XKNAhg3Rk
      - name: objectType
        in: query
        description: 'objectType  of `objectId`. **If objectId is specified, objectType  is required**. (Supported values : `PROJECT`, `VIEW`, `CLASH`, `RELEASE`, `COMMENT`, `FOLDER`, `FILE`, `TODO`, `VIEW2D`)'
        schema:
          type: string
          example: RELEASE
      - name: pageSize
        in: query
        description: The desired page size for the response list. The allowed minimum value = 1 and maximum value = 15.  <br> For example, if the pageSize = 10,  it is guaranteed that the resource count in the response does not exceed 10, however, it does not guarantee that exactly 10 items will be returned.
        schema:
          type: number
          default: 15
      - name: lastId
        in: query
        description: The lastId of the response list in the previous page. This value can be fetched from the response header Last-Id or the last resource Id from the previously fetched page list. If this value is not provided, the default paging will be from the beginning.
        schema:
          type: string
          example: P_INzmU25NU
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityListRequest'
        required: true
      responses:
        '200':
          description: The `details` contains the corresponding object associated with the activity. A minimal representation is provided in the `ActivityObject`. If the client needs additional information about the object, use the corresponding resource endpoint. <br> In case of multiple activities clubbed together, the count is provided in the `statistics`. To fetch additional information in case of multiple activities, use the [/activities/logs](#/activities/logs) endpoint. To fetch additional information about the object, use the corresponding resource endpoints based on the type of object.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActivityListResponse'
      operationId: postActivitiesList
      x-operation-id-source: derived
  /activities/{activityId}:
    get:
      tags:
      - Activities
      summary: Activity Details by activityId
      description: API to fetch details an activity by id
      operationId: ActivityDetailsbyactivityId
      parameters:
      - name: activityId
        in: path
        description: Id of the activity.
        required: true
        schema:
          type: string
          example: woC32em2Fb0
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityDetailsResponse'
  /activities/{activityId}/logs:
    get:
      tags:
      - Activities
      summary: Activity logs by activityId
      description: API to fetch list of logs of an activity by id
      operationId: ActivitylogsbyactivityId
      parameters:
      - name: activityId
        in: path
        description: Id of the activity.
        required: true
        schema:
          type: string
          example: woC32em2Fb0
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActivityLogsByActivityIdResponse'
                description: ''
                example:
                - id: Dyfw481f356
                  displayName: New Todo
                  type: TODO
                  activityType: TODO_EDIT_DESCRIPTION
                  oldValue: Test Description
                  newValue: This is Test Description
                - id: Dyfw481f357
                  displayName: New Todo
                  type: TODO
                  activityType: TODO_EDIT_DUEDATE
                  oldValue: 2015-07-19T00:00:00+0000
                  newValue: 2015-07-20T00:00:00+0000
              example:
              - id: Dyfw481f358
                displayName: New Todo
                type: TODO
                activityType: TODO_EDIT_DESCRIPTION
                oldValue: Test Description
                newValue: This is Test Description
              - id: Dyfw481f359
                displayName: New Todo
                type: TODO
                activityType: TODO_EDIT_DUEDATE
                oldValue: 2015-07-19T00:00:00+0000
                newValue: 2015-07-20T00:00:00+0000
components:
  schemas:
    ActivityMessage:
      title: ActivityMessage
      required:
      - id
      - displayName
      - type
      type: object
      description: Valid only for several types of activities
      properties:
        id:
          type: string
          description: Id of the activity (Id of the File, Folder, Todo etc.)
        displayName:
          type: string
          description: display name of the activity
        type:
          type: string
          description: Type of object
      example:
        id: 1rNbvWZv277
        displayName: xyz.jpg
        type: FILE
        oldValue: abc.jpg
        newValue: xyz.jpg
    ActivityLogsByActivityIdResponse:
      title: ActivityLogsByActivityIdResponse
      required:
      - id
      - displayName
      - type
      - activityType
      - oldValue
      - newValue
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        type:
          type: string
        activityType:
          type: string
        oldValue:
          type: string
        newValue:
          type: string
      example:
        id: Dyfw481f453
        displayName: New Todo
        type: TODO
        activityType: TODO_EDIT_DESCRIPTION
        oldValue: Test Description
        newValue: This is Test Description
    ActivityDetailsResponse:
      title: ActivityDetailsResponse
      required:
      - object
      - statistics
      type: object
      properties:
        object:
          $ref: '#/components/schemas/ActivityObject'
        statistics:
          type: array
          items:
            $ref: '#/components/schemas/ActivityStatistic'
          description: Valid only for several types of activities
        message:
          $ref: '#/components/schemas/ActivityMessage'
      example:
        object:
          id: 1rNbvWZv276
          displayName: xyz.jpg
          type: FILE
          oldValue: abc.jpg
          newValue: xyz.jpg
        statistics:
        - activityType: FILE_RENAME
          count: 1
    ActivityStatistic:
      title: ActivityStatistic
      description: If the count > 1 and if deeper information is needed, use the /logs endpoint for fetching changed entities or fields. For latest information about the resource, use the corresponding resource endpoint.
      required:
      - activityType
      - count
      type: object
      properties:
        activityType:
          type: string
        count:
          type: integer
          format: int32
      example:
        activityType: FILE_RENAME
        count: 1
    ActivityObject:
      title: ActivityObject
      description: In case of multiple activities on a group of objects that don't have a common object acted upon, the object will be null. Eg. FILE_DOWNLOAD of different files from different folders performed together as one activity.
      required:
      - id
      - displayName
      - type
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        type:
          type: string
      example:
        id: 1rNbvWZv278
        displayName: xyz.jpg
        type: FILE
        oldValue: abc.jpg
        newValue: xyz.jpg
    ActivityExportDetails:
      title: ActivityExportDetails
      required:
      - id
      - projectId
      - status
      - filters
      type: object
      properties:
        id:
          type: string
        projectId:
          type: string
        status:
          type: string
        downloadUrl:
          type: string
          description: URL for download (present in reponse)
        filters:
          type: array
          items:
            type: string
          description: ''
        users:
          type: array
          items:
            type: string
          description: ''
        groups:
          type: array
          items:
            type: string
          description: ''
        fromDate:
          type: string
        toDate:
          type: string
      example:
        id: tJ2lDVMEiOY
        projectId: MmpytDCiOQM
        status: PENDING
        filters:
        - FILE
        - FOLDER
        users:
        - 1rNbvWZv281
        - Du0rV40exHk
        groups:
        - 1rNbvWZv282
        - Du0rV40exHk
        fromDate: 2017-05-05T00:00:00+0000
        toDate: 2017-05-09T00:00:00+0000
    ActivityListResponse:
      type: array
      items:
        $ref: '#/components/schemas/ActivityResponseObject'
    ActivityResponseObject:
      title: ActivityResponseObject
      type: object
      properties:
        id:
          type: string
          description: Id of activity
        type:
          type: string
          description: type of activity action performed.
          example: FILE_ADD
        createdOn:
          type: string
          format: date-time
          description: (timestamp) - An ISO8601 date when the activity was created
        createdBy:
          type: string
          format: uuid
          description: TID UUID of activity created user.
        details:
          type: object
          description: activity details.
          properties:
            object:
              $ref: '#/components/schemas/ActivityObject'
            statistics:
              $ref: '#/components/schemas/ActivityStatistic'
        status:
          type: string
          description: Current status of activity object.
    CreateNewExportRequest:
      title: CreateNewExportRequest
      type: object
      properties:
        filters:
          type: array
          items:
            type: string
          description: ''
        users:
          type: array
          items:
            type: string
          description: ''
        groups:
          type: array
          items:
            type: string
          description: ''
        fromDate:
          type: string
        toDate:
          type: string
      example:
        filters:
        - TODO
        - RELEASE
        users:
        - 1rNbvWZv279
        - Du0rV40exHk
        groups:
        - 1rNbvWZv280
        - Du0rV40exHk
        fromDate: 2017-05-05T00:00:00+0000
        toDate: 2017-05-09T00:00:00+0000
    ActivityListRequest:
      title: ActivityListRequest
      required:
      - projectId
      type: object
      properties:
        projectId:
          type: string
        filters:
          type: object
          description: optional filters for activities.
          properties:
            fromDate:
              type: string
              description: start datetime to filter
              format: date
            toDate:
              type: string
              description: end datetime to filter in ISO8601 date
              format: date
              example: 2022-05-08T07:30:00+0000
            types:
              type: string
              enum:
              - FILE_ADD
              - FILE_DELETE
              - FILE_MOVE
              - FILE_RENAME
              - FILE_DOWNLOAD
              - FILE_CHECKOUT
              - FILE_CHECKIN
              - FILE_RESTORE
              - SYNC
              - FOLDER_ADD
              - FOLDER_DELETE
              - FOLDER_MOVE
              - FOLDER_RENAME
              - FOLDER_RESTORE
              - FOLDER_DOWNLOAD
              - PROJECT_JOIN
              - USER_IN_PROJECT_ADD
              - USER_IN_PROJECT_REMOVE
              - USER_IN_PROJECT_LEAVE
              - EXCEL_IMPORT_TEAM
              - SNAPSHOT_ADD
              - SNAPSHOT_DELETE
              - SNAPSHOT_UPDATE
              - SNAPSHOT_RENAME
              - SNAPSHOT_UPDATE_DESCRIPTION
              - VIEW2D_ADD
              - VIEW2D_ADD_IMPLICIT
              - VIEW2D_DELETE
              - VIEW2D_UPDATE
              - VIEW2D_ADD_ASSIGNEES
              - VIEW2D_REMOVE_ASSIGNEES
              - VIEW2D_RENAME
              - VIEW2D_UPDATE_DESCRIPTION
              - CLASH_ADD
              - CLASH_DELETE
              - RELEASE_CREATE
              - RELEASE_ADD_FILES
              - RELEASE_REMOVE_FILES
              - RELEASE_FILE_DOWNLOAD
              - RELEASE_SENT
              - RELEASE_DELETE
              - RELEASE_RENAME
              - RELEASE_EDIT_DUE_DATE
              - RELEASE_EDIT_NOTES
              - TODO_ADD
              - TODO_EDIT_DESCRIPTION
              - TODO_EDIT_DUE_DATE
              - TODO_EDIT_PERCENT_COMPLETE
              - TODO_EDIT_PRIORITY
              - TODO_EDIT_STATUS
              - TODO_EDIT_TITLE
              - TODO_EDIT_TYPE
              - TODO_EDIT
              - TODO_DELETE
              - TODO_ADD_FILES
              - TODO_REMOVE_FILES
              - TODO_ADD_SNAPSHOTS
              - TODO_REMOVE_SNAPSHOT
              - TODO_SNAPSHOT_UPDATE
              - TODO_ADD_VIEW2D
              - TODO_REMOVE_VIEW2D
              - TODO_VIEW2D_UPDATE
              - TODO_ADD_CLASH_ITEM
              - TODO_ADD_ASSIGNEES
              - TODO_REMOVE_ASSIGNEES
              - EXCEL_IMPORT_TODO
              - COMMENT_ADD
              - COMMENT_EDIT
              - COMMENT_DELETE
              - SHARE_ADD
              - SHARE_DELETE
              - SHARE_UPDATE_MODE
              - SHARE_UPDATE_MESSAGE
              - SHARE_UPDATE_NOTIFY
              - SHARE_UPDATE_EXPIRY_DATE
              - SHARE_UPDATE_PERMISSION
              - SHARE_UPDATE_LATEST_VERSION
              - PROJECT_RENAME
              - PROJECT_EDIT_DESCRIPTION
              - PROJECT_EDIT_END_DATE
              - PROJECT_EDIT_START_DATE
              - PROJECT_EDIT_ADDRESS
              - PROJECT_EDIT_CRS
              - TOPIC_CREATED
              - TOPIC_EDITED
              - TOPIC_DELETED
              - TOPIC_DOCREFS_ADDED
              - TOPIC_DOCREFS_REMOVED
              - TOPIC_VIEW_ADDED
              - TOPIC_VIEW_DELETED
              - TOPIC_COMMENT_ADDED
              - TOPIC_COMMENT_EDITED
              - TOPIC_COMMENT_DELETED
              description: filter by activity action types. This cannot be used along with objectId/objectType filter.
            users:
              type: array
              items:
                type: string
                format: uuid
              description: Filter for activity created users by TID UUID
            groups:
              type: array
              items:
                type: string
                example: tJ2lDVMEiOY
              description: Filter for groups of activity created users
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT