Trimble Login API

openapi: 3.2.0
info:
  title: MasterData Login API
  description: 'The Master Data management API allows for an external system to create, retrieve, update or delete TruckMate configuration data, such as Client, Vendor and Driver profiles, as well as sites, zones, commodity codes etc.


    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: Login
  description: The login authentication endpoints are used to generate a JWT (JSON Web Token) to be used as the authorization bearer token for subsequent API calls. Web users and their login credentials are configured either through the Profiles > TruckMate Customer and Vendor Profiles application > TM4Web Configuration tab. TM4Web Access Group configuration options are setup in the TruckMate for Web > Web Admin application.
paths:
  /login:
    get:
      summary: Renew login session
      description: Retrieves a new JWT (JSON Web Token) with a updated expiry time based on the supplied JWT authorization.
      operationId: GetAuth
      security:
      - webuserJwtAuth: []
      tags:
      - Login
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/login'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    post:
      summary: Generate a JWT
      description: Generates and returns a JWT based on the supplied login credentials. The JWT can then be used as the authorization bearer token with subsequent API calls.
      operationId: PostAuth
      tags:
      - Login
      requestBody:
        description: A single JSON object containing the username and password of a TM4Web user.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/login'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
components:
  schemas:
    login:
      type: object
      properties:
        JWT:
          type: string
          readOnly: true
    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
    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'
    LoginRequest:
      type: object
      properties:
        password:
          type: string
          maxLength: 128
        username:
          type: string
          maxLength: 128
      required:
      - password
      - username
  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
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
    clientApiKeyAuth:
      type: http
      description: Client API Key
      scheme: bearer
    vendorApiKeyAuth:
      type: http
      description: Vendor API Key
      scheme: bearer
externalDocs:
  url: https://learn.transportation.trimble.com/