Trimble User API

The User API from Trimble — 4 operation(s) for user.

GitHub OpenAPI

Operations 6

GET /users/me Get current user details #
GET /users/{userId} Get user details by Id #
GET /users/{userId}/properties List user properties #
PUT /users/{userId}/properties Add or update user properties #
GET /users/{userId}/properties/{key} Get user properties by Key #
DELETE /users/{userId}/properties/{key} Delete user property by Key #

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-user-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-user-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect User API
  description: '**Trimble Connect Support:** connect-support@trimble.com


    **URL:** https://connect.trimble.com


    **License:** Trimble Connect SDK Internal Use License


    **Terms of Service:** https://developer.trimble.com/docs/connect/terms


    # 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.


    All endpoints require a Trimble Identity (Trimble ID) JWT bearer token.


    ## 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: v2
  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://us-east.api.trimble.com/connect/v2
  description: Prod US
- url: https://eu.api.trimble.com/connect/v2
  description: Prod EU
- url: https://ap-au.api.trimble.com/connect/v2
  description: Prod AP2
- url: https://ap-sg.api.trimble.com/connect/v2
  description: Prod AP1
- url: https://eu-gb.api.trimble.com/connect/v2
  description: Prod UK
security:
- BearerAuth: []
tags:
- name: User
paths:
  /users/me:
    get:
      tags:
      - User
      summary: Get current user details
      description: 'Fetch the details of the currently authenticated user. Equivalent to calling GET /users/{userId} with userId set to the literal string ''me''.


        Fetch the user details by Id. Supported Id values are user''s TC Id, Tiduuid and *me* string. Accessible for the current calling user and those who own Site Admin privilege and also works in Project and Account Admin context.

        * **fields** is an optional param and accepts comma-separated field names. Currently, supported fields are *roles and properties*. This param can be used to fetch additional details of the user such as roles and properties.

        * **context** is also an optional param and supported values are PROJECT:{projectId} and ACCOUNT:{accountId}. This param is used for validating the access permission for the calling user based on the value passed.'
      operationId: getCurrentUser
      parameters:
      - name: context
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: User details by Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAppDto'
        '204':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '400':
          description: Invalid Id or context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '403':
          description: Permission denied for the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
  /users/{userId}:
    get:
      tags:
      - User
      summary: Get user details by Id
      description: 'Fetch the user details by Id. Supported Id values are user''s TC Id, Tiduuid and *me* string. Accessible for the current calling user and those who own Site Admin privilege and also works in Project and Account Admin context.

        * **fields** is an optional param and accepts comma-separated field names. Currently, supported fields are *roles and properties*. This param can be used to fetch additional details of the user such as roles and properties.

        * **context** is also an optional param and supported values are PROJECT:{projectId} and ACCOUNT:{accountId}. This param is used for validating the access permission for the calling user based on the value passed.'
      operationId: getUserById
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: User details by Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAppDto'
        '204':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '400':
          description: Invalid Id or context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '403':
          description: Permission denied for the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
  /users/{userId}/properties:
    get:
      tags:
      - User
      summary: List user properties
      description: 'List all the user properties. Accessible for the current calling user and those who own Site Admin privilege and also works in Project and Account Admin context.

        * **context** is an optional param and supported values are PROJECT:{projectId} and ACCOUNT:{accountId}. This param is used for validating the access permission for the calling user based on the value passed.'
      operationId: getUserProperties
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: User properties
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PropertyDto'
        '204':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '400':
          description: Invalid UUID or context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '403':
          description: Permission denied for the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
    put:
      tags:
      - User
      summary: Add or update user properties
      description: Add or update the user properties. Accessible for the current calling user and those who own Site Admin privilege.
      operationId: putUserProperty
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        required: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyDto'
        required: true
      responses:
        '200':
          description: User properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyDto'
        '204':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '400':
          description: Invalid request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '403':
          description: Permission denied for the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
  /users/{userId}/properties/{key}:
    get:
      tags:
      - User
      summary: Get user properties by Key
      description: 'Fetch the user properties by Key. Accessible for the current calling user and those who own Site Admin privilege and also works in Project and Account Admin context.

        * **context** is an optional param and supported values are PROJECT:{projectId} and ACCOUNT:{accountId}. This param is used for validating the access permission for the calling user based on the value passed.'
      operationId: getUserPropertyByKey
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: context
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: User properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyDto'
        '204':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '400':
          description: Invalid UUID or context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '403':
          description: Permission denied for the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
    delete:
      tags:
      - User
      summary: Delete user property by Key
      description: Delete the user property by Key. Accessible for the current calling user and those who own Site Admin privilege.
      operationId: deleteUserPropertyByKey
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: User properties
        '204':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
        '403':
          description: Permission denied for the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError_user_api'
components:
  schemas:
    UserRoleDto:
      type: object
      properties:
        id:
          type: string
        roleId:
          type: string
        roleUuid:
          type: string
        roleName:
          type: string
        userId:
          type: string
        tidUuid:
          type: string
        identityType:
          type: string
    UserAppDto:
      type: object
      properties:
        status:
          type: string
        id:
          type: string
        tiduuid:
          type: string
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        trn:
          type: string
        emailVerified:
          type: boolean
        createdOn:
          type: string
          format: date-time
        modifiedOn:
          type: string
          format: date-time
        phone:
          type: string
        timeZone:
          type: string
        language:
          type: string
        title:
          type: string
        hasImage:
          type: boolean
        properties:
          type: array
          items:
            $ref: '#/components/schemas/PropertyDto'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserRoleDto'
    ValueDto:
      type: object
      properties:
        value:
          type: string
    PropertyDto:
      type: object
      properties:
        tidUuid:
          type: string
        key:
          type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/ValueDto'
    ApiError_user_api:
      type: object
      properties:
        message:
          type: string
        details:
          type: string
        errorCode:
          type: string
        errorDetails:
          type: object
          additionalProperties:
            type: object
        statusCode:
          type: string
          enum:
          - 100 CONTINUE
          - 101 SWITCHING_PROTOCOLS
          - 102 PROCESSING
          - 103 EARLY_HINTS
          - 200 OK
          - 201 CREATED
          - 202 ACCEPTED
          - 203 NON_AUTHORITATIVE_INFORMATION
          - 204 NO_CONTENT
          - 205 RESET_CONTENT
          - 206 PARTIAL_CONTENT
          - 207 MULTI_STATUS
          - 208 ALREADY_REPORTED
          - 226 IM_USED
          - 300 MULTIPLE_CHOICES
          - 301 MOVED_PERMANENTLY
          - 302 FOUND
          - 303 SEE_OTHER
          - 304 NOT_MODIFIED
          - 307 TEMPORARY_REDIRECT
          - 308 PERMANENT_REDIRECT
          - 400 BAD_REQUEST
          - 401 UNAUTHORIZED
          - 402 PAYMENT_REQUIRED
          - 403 FORBIDDEN
          - 404 NOT_FOUND
          - 405 METHOD_NOT_ALLOWED
          - 406 NOT_ACCEPTABLE
          - 407 PROXY_AUTHENTICATION_REQUIRED
          - 408 REQUEST_TIMEOUT
          - 409 CONFLICT
          - 410 GONE
          - 411 LENGTH_REQUIRED
          - 412 PRECONDITION_FAILED
          - 413 CONTENT_TOO_LARGE
          - 413 PAYLOAD_TOO_LARGE
          - 414 URI_TOO_LONG
          - 415 UNSUPPORTED_MEDIA_TYPE
          - 416 REQUESTED_RANGE_NOT_SATISFIABLE
          - 417 EXPECTATION_FAILED
          - 418 I_AM_A_TEAPOT
          - 421 MISDIRECTED_REQUEST
          - 422 UNPROCESSABLE_CONTENT
          - 422 UNPROCESSABLE_ENTITY
          - 423 LOCKED
          - 424 FAILED_DEPENDENCY
          - 425 TOO_EARLY
          - 426 UPGRADE_REQUIRED
          - 428 PRECONDITION_REQUIRED
          - 429 TOO_MANY_REQUESTS
          - 431 REQUEST_HEADER_FIELDS_TOO_LARGE
          - 451 UNAVAILABLE_FOR_LEGAL_REASONS
          - 500 INTERNAL_SERVER_ERROR
          - 501 NOT_IMPLEMENTED
          - 502 BAD_GATEWAY
          - 503 SERVICE_UNAVAILABLE
          - 504 GATEWAY_TIMEOUT
          - 505 HTTP_VERSION_NOT_SUPPORTED
          - 506 VARIANT_ALSO_NEGOTIATES
          - 507 INSUFFICIENT_STORAGE
          - 508 LOOP_DETECTED
          - 509 BANDWIDTH_LIMIT_EXCEEDED
          - 510 NOT_EXTENDED
          - 511 NETWORK_AUTHENTICATION_REQUIRED
        timestamp:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Trimble Identity (Trimble ID) JWT access token.