Trimble Imaging Documents API

The Imaging Documents API allows for public viewing of specific imaging documents through a URL linked with a time sensitive token. Synergize by Microdea is currently the only Imaging Document Management System supported by the TruckMate Imaging Documents API. The Synergize SOAP API is used to retrieve imaging documents from the configured imaging vendor repository. Imaging Document Type must be one of the imaging document types configured in Codes Maintenance > Imaging > Imaging Vendor > Viewer.

GitHub OpenAPI

Operations 2

GET /imagingDocuments Retrieve imaging documents information from the imaging server #
GET /imagingDocuments/{imagingDocumentId} Retrieve a specific imaging document from the image system #

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-imaging-documents-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-imaging-documents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: TruckMate REST Imaging Documents 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: Imaging Documents
  description: 'The Imaging Documents API allows for public viewing of specific imaging documents through a URL linked with a time sensitive token.

    Synergize by Microdea is currently the only Imaging Document Management System supported by the TruckMate Imaging Documents API. The Synergize SOAP API is used to retrieve imaging documents from the configured imaging vendor repository.

    Imaging Document Type must be one of the imaging document types configured in Codes Maintenance > Imaging > Imaging Vendor > Viewer.'
paths:
  /imagingDocuments:
    get:
      summary: Retrieve imaging documents information from the imaging server
      description: Retrieves imaging documents information from the imaging server.
      operationId: GetServerImagingDocuments
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Imaging Documents
      parameters:
      - name: documentType
        in: query
        description: The document type to use for document retrieval. The document type can be viewed in the Codes Maintenance > Imaging > Imaging Vendor > Viewer.
        required: true
        schema:
          type: string
      - name: searchValue
        in: query
        description: A search value that is used to look up documents in the imaging repository (e.g. TruckMate Bill Number)
        required: true
        schema:
          type: string
      - name: imagingVendor
        in: query
        description: 'The imaging vendor to use for document retrieval. Allowed values are: microdea, workoptima. (Currently, only microdea is supported.)'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServerImagingDocuments200'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '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'
  /imagingDocuments/{imagingDocumentId}:
    parameters:
    - name: imagingDocumentId
      in: path
      description: Imaging document path parameter
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a specific imaging document from the image system
      description: 'Retrieves an imaging document from the imaging server.

        The imaging document type and imaging document identifier query parameters are used along with the token provided in the query string to determine access to the imaging document.

        Imaging documents will be converted and returned in the specified document format (only PDF is supported at this time).'
      operationId: GetImagingDocument
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Imaging Documents
      parameters:
      - name: documentType
        in: query
        description: The document type to use for document retrieval. The document type can be viewed in the Codes Maintenance > Imaging > Imaging Vendor > Viewer.
        required: true
        schema:
          type: string
      - name: searchValue
        in: query
        description: A search value that is used to look up documents in the imaging repository (e.g. TruckMate Bill Number)
        required: true
        schema:
          type: string
      - name: imagingVendor
        in: query
        description: 'The imaging vendor to use for document retrieval. Allowed values are: microdea, workoptima. (Currently, only microdea is supported.)'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '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'
components:
  schemas:
    imagingDocument:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        documentName:
          type:
          - string
          - 'null'
        documentType:
          type:
          - string
          - 'null'
        truckmateTable:
          type:
          - string
          - 'null'
        truckmateField:
          type:
          - string
          - 'null'
        imagingVendor:
          type:
          - string
          - 'null'
        fileExtension:
          type:
          - string
          - 'null'
        createdAt:
          type:
          - string
          - 'null'
        imagingDocumentUrl:
          type:
          - string
          - 'null'
    GetServerImagingDocuments200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        count:
          type: integer
        imagingDocuments:
          type: array
          items:
            $ref: '#/components/schemas/imagingDocument'
    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'
  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/