Trimble Web Users API

Retrieves, creates and updates TM4Web users. TM4Web users can be viewed and maintained in the TruckMate Customer & Vendor Profiles program on the TM4Web Configuration tab. TM4Web users can log into the TM4Web application (TruckMate's web-based, self-service portal). TM4Web credentials can also be used with API calls to retrieve orders based on some of their associated Web Administration configuration options through the TruckMate REST API > GET Orders endpoint.

GitHub OpenAPI

Operations 4

GET /webUsers Retrieve TM4Web users #
POST /webUsers Create a TM4Web user #
GET /webUsers/{username} Retrieve a specific TM4Web user #
PUT /webUsers/{username} Update an existing TM4Web user #

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-web-users-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-web-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: TruckMate REST Web Users API
  description: 'The TruckMate REST APIs are a comprehensive set of RESTful services, allowing you to seamlessly integrate with major TruckMate product areas. The TruckMate REST APIs allow developers to integrate the TruckMate product with custom or 3rd party applications, automate tasks, and much more.


    Business use cases of the TruckMate REST APIs include:


    - Internal systems: Use the APIs to share data and streamline internal business processes.

    - External data sharing: In addition to internal networking, the APIs allow sharing TruckMate data with third party systems to connect and share information.

    - App integrations: Access TruckMate data in real time.

    - Embedded content: Request data from the TruckMate REST APIs to embed pieces of content onto your corporate site.


    The endpoints and methods available are dependent on the license keys and authorization methods used. Use the following documentation to determine how to interact with the various available components.


    Download latest released OpenAPI


    This documentation is based on the most currently released version of TruckMate. Documentation for previous versions can be accessed by navigating to the openapi.json endpoint for any given API (the service must be set up and running). For example: http://DOMAIN/openapi.json


    ---


    © 2026, Trimble Inc. All rights reserved. Unauthorized copying prohibited. Software functions, including our APIs and their specification, are subject to change without notice. Information contained herein is Trimble Confidential Information, used under license.


    ---'
  version: '1'
  x-tm-release: 26.3.125.0
tags:
- name: Web Users
  description: Retrieves, creates and updates TM4Web users. TM4Web users can be viewed and maintained in the TruckMate Customer & Vendor Profiles program on the TM4Web Configuration tab. TM4Web users can log into the TM4Web application (TruckMate's web-based, self-service portal). TM4Web credentials can also be used with API calls to retrieve orders based on some of their associated Web Administration configuration options through the TruckMate REST API > GET Orders endpoint.
paths:
  /webUsers:
    get:
      summary: Retrieve TM4Web users
      description: Retrieves an array of TM4Web users and their properties. Use the optional limit and offset query parameters to page through the resulting sets of data.
      operationId: GetWebusers
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - Web Users
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebusers200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    post:
      summary: Create a TM4Web user
      description: Allows creating TM4Web users one at a time. If configured in Web Administration to enable new users by default, the user can immediately log into TM4Web, or be used for subsequent API calls to retrieve orders. Usernames must be unique and the access code must be a valid TM4Web access code linked to either a TruckMate client or vendor, as configured in Web Administration.
      operationId: PostWebusers
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - Web Users
      requestBody:
        description: A single JSON object containing the properties of the new TM4Web user to be created.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebUserRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webUsers'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /webUsers/{username}:
    parameters:
    - name: username
      in: path
      description: TM4Web username identifier
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a specific TM4Web user
      description: Retrieves an existing TM4Web user as specified by the username in the target path parameter.
      operationId: GetWebuser
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - Web Users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webUsers'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    put:
      summary: Update an existing TM4Web user
      description: Updates one or more properties of an existing TM4Web user. Can be used for partial updates, as only the properties sent in the request will be updated.
      operationId: PutWebUsers
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - Web Users
      requestBody:
        description: A single JSON object containing the properties to be updated. All fields are optional, but at least one field must be sent.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebUserPutRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webUsers'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Specifies the number of items to skip before beginning to select the records to return.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: Specifies the maximum number of items to include in the response results.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 20
  schemas:
    WebUserRequest:
      type: object
      properties:
        username:
          type: string
          maxLength: 128
        accessCode:
          type: string
          maxLength: 15
        password:
          type: string
          maxLength: 40
        firstName:
          type: string
          maxLength: 20
        lastName:
          type: string
          maxLength: 20
        email:
          type: string
          format: email
          maxLength: 128
        company:
          type: string
          maxLength: 30
        department:
          type: string
          maxLength: 15
        address1:
          type: string
          maxLength: 30
        address2:
          type: string
          maxLength: 30
        city:
          type: string
          maxLength: 20
        state:
          type: string
          maxLength: 4
        country:
          type: string
          maxLength: 2
        postalCode:
          type: string
          maxLength: 10
        phone:
          type: string
          maxLength: 15
        phoneExt:
          type: string
          maxLength: 5
        fax:
          type: string
          maxLength: 15
        language:
          type: string
          maxLength: 3
        enabled:
          type: string
          description: Web User is Enabled/Disabled
          enum:
          - 'False'
          - 'True'
        administrator:
          type: string
          description: Administrator privilege
          enum:
          - 'False'
          - 'True'
        trace:
          type: string
          maxLength: 1000
        invalidLoginAttempts:
          type: integer
        invoice:
          type: string
          description: Invoice page access
          enum:
          - 'False'
          - 'True'
        webUuid:
          type: string
          maxLength: 40
      required:
      - username
      - accessCode
      - email
    ARTError:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        code:
          type: string
          description: Error code (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
        description:
          type: string
          description: Human-readable description (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
    webUsers:
      type: object
      properties:
        username:
          type: string
          maxLength: 128
        accessCode:
          type: string
          maxLength: 15
        firstName:
          type: string
          maxLength: 20
        lastName:
          type: string
          maxLength: 20
        email:
          type: string
          maxLength: 128
          oneOf:
          - enum:
            - ''
          - format: email
        company:
          type: string
          maxLength: 30
        department:
          type: string
          maxLength: 15
        address1:
          type: string
          maxLength: 30
        address2:
          type: string
          maxLength: 30
        city:
          type: string
          maxLength: 20
        state:
          type: string
          maxLength: 4
        country:
          type: string
          maxLength: 2
        postalCode:
          type: string
          maxLength: 10
        phone:
          type: string
          maxLength: 15
        phoneExt:
          type: string
          maxLength: 5
        fax:
          type: string
          maxLength: 15
        language:
          type: string
          maxLength: 3
        enabled:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
          description: Web User is Enabled/Disabled
        administrator:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
          description: Administrator privilege
        cookieId:
          type: string
          maxLength: 50
        invalidLoginAttempts:
          type:
          - integer
          - 'null'
        lastLogin:
          type:
          - string
          - 'null'
          description: 'datetime: yyyy-MM-dd hh:mm:ss'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        trace:
          type: string
          maxLength: 1000
        invoice:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
          description: Invoice page access
        passwordCreated:
          type:
          - string
          - 'null'
          description: 'datetime: yyyy-MM-dd hh:mm:ss'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        webUuid:
          type: string
          maxLength: 40
    ARTErrors:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          enum:
          - 400
          - 401
          - 403
          - 404
          - 405
          - 409
          - 429
          - 500
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ARTError'
    GetWebusers200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        count:
          type: integer
        webUsers:
          type: array
          items:
            $ref: '#/components/schemas/webUsers'
    WebUserPutRequest:
      type: object
      properties:
        accessCode:
          type: string
          maxLength: 15
        password:
          type: string
          maxLength: 40
        firstName:
          type: string
          maxLength: 20
        lastName:
          type: string
          maxLength: 20
        email:
          type: string
          format: email
          maxLength: 128
        company:
          type: string
          maxLength: 30
        department:
          type: string
          maxLength: 15
        address1:
          type: string
          maxLength: 30
        address2:
          type: string
          maxLength: 30
        city:
          type: string
          maxLength: 20
        state:
          type: string
          maxLength: 4
        country:
          type: string
          maxLength: 2
        postalCode:
          type: string
          maxLength: 10
        phone:
          type: string
          maxLength: 15
        phoneExt:
          type: string
          maxLength: 5
        fax:
          type: string
          maxLength: 15
        language:
          type: string
          maxLength: 3
        enabled:
          type: string
          description: Web User is Enabled/Disabled
          enum:
          - 'False'
          - 'True'
        administrator:
          type: string
          description: Administrator privilege
          enum:
          - 'False'
          - 'True'
        trace:
          type: string
          maxLength: 1000
        invalidLoginAttempts:
          type: integer
        invoice:
          type: string
          description: Invoice page access
          enum:
          - 'False'
          - 'True'
        webUuid:
          type: string
          maxLength: 40
  securitySchemes:
    tidJwtAuth:
      type: http
      description: A time-limited JSON Web Token generated via separate POST request using TID
      scheme: bearer
    webuserJwtAuth:
      type: http
      description: A fresh JSON Web Token expires in four hours. It can be renewed by making a GET request to /login endpoint, or generated by making a POST request to /login endpoint
      scheme: bearer
    clientApiKeyAuth:
      type: http
      description: Client API Key
      scheme: bearer
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
    vendorApiKeyAuth:
      type: http
      description: Vendor API Key
      scheme: bearer
externalDocs:
  url: https://learn.transportation.trimble.com/