Trimble Documents API

The 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 Document Management System supported by the TruckMate Documents API. The Synergize SOAP API is used to retrieve documents from the configured repository. Document Type must be one of the document types configured in Codes Maintenance > Imaging configured for the ART.EXE.

GitHub OpenAPI

Operations 3

GET /documents Retrieve imaging document configuration records #
GET /documents/{documentType}/searchValues/{documentIdentifier}/{documentFormat} Retrieve a document from the image system #
POST /documents/{documentType}/searchValues/{documentIdentifier}/token Generate document access token #

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-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-documents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: TruckMate REST 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: Documents
  description: 'The 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 Document Management System supported by the TruckMate Documents API. The Synergize SOAP API is used to retrieve documents from the configured repository.

    Document Type must be one of the document types configured in Codes Maintenance > Imaging configured for the ART.EXE.'
paths:
  /documents:
    parameters:
    - 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: false
      schema:
        type: string
    get:
      summary: Retrieve imaging document configuration records
      description: Retrieves imaging document configuration records.
      operationId: GetImagingDocumentConfigs
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Documents
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/select'
      - name: useDefaultImagingVendor
        in: query
        description: 'Returns configured document types for the imaging vendor specified by the appconfig option: ART.EXE - Default ART Imaging Vendor'
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetImagingDocumentConfigs200'
        '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'
  /documents/{documentType}/searchValues/{documentIdentifier}/{documentFormat}:
    parameters:
    - name: documentType
      in: path
      description: document type
      required: true
      schema:
        type: string
    - name: documentIdentifier
      in: path
      description: document identifier
      required: true
      schema:
        type: string
    - name: documentFormat
      in: path
      description: Format in which to return document (only PDF is supported currently)
      required: true
      schema:
        type: string
    - name: token
      in: query
      description: Time sensitive access token
      required: true
      schema:
        type: string
    - name: documentId
      in: query
      description: Identifier used when more than one document exists for a given matching document type and document identifier
      required: false
      schema:
        type: string
    get:
      summary: Retrieve a document from the image system
      description: 'Retrieves a document from the imaging server.

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

        Documents will be converted and returned in the specified document format (only PDF is supported at this time).


        As of TruckMate 25.1, the documentId parameter can be used to provide the specific identifier when more than one document exists for a matching documentType and documentIdentifier.'
      operationId: GetDocument
      tags:
      - Documents
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /documents/{documentType}/searchValues/{documentIdentifier}/token:
    parameters:
    - name: documentType
      in: path
      description: document type
      required: true
      schema:
        type: string
    - name: documentIdentifier
      in: path
      description: document identifier
      required: true
      schema:
        type: string
    post:
      summary: Generate document access token
      description: 'Generates a time sensitive token to be used in subsequent calls to retrieve the specific document from the imaging system.

        The document type, as configured in the imaging system, and a document identifier, such as bill number, are required path parameters.

        TruckMate API Credentials are required to generate the access token. The user configured in the TruckMate ART Server Administrator to run the TruckMate API Service provides the profile that determines which imaging documents can be accessed for generating the access token.'
      operationId: PostToken
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Documents
      requestBody:
        description: A single JSON object containing the length of time the token should be valid. Default expiry is one week, if no payload is provided.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImagingDocumentConfigTokenRequestBody'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImagingDocumentConfigTokenDto'
        '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'
        '404':
          description: Not Found
          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
    select:
      name: $select
      in: query
      description: Select allows to request a specified set of properties, see [Selecting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31361040)
      required: false
      style: form
      explode: true
      schema:
        type: string
    orderBy:
      name: $orderBy
      in: query
      description: Field(s) to order returned resource by, with optional direction. E.g., "fieldName desc, fieldName2"
      required: false
      style: form
      explode: true
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter). Note, not all features of oData filter syntax are supported.
      required: false
      style: form
      explode: true
      schema:
        type: string
  schemas:
    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
    GetImagingDocumentConfigs200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        filter:
          type: string
        sort:
          type: string
        select:
          type: string
        count:
          type: integer
        documents:
          type: array
          items:
            $ref: '#/components/schemas/imagingDocumentConfig'
    imagingDocumentConfig:
      type: object
      properties:
        id:
          oneOf:
          - type: string
            maxLength: 40
          - type: number
        documentName:
          type:
          - string
          - 'null'
          maxLength: 40
        documentType:
          type:
          - string
          - 'null'
          maxLength: 40
        truckmateTable:
          type:
          - string
          - 'null'
          maxLength: 40
        truckmateField:
          type:
          - string
          - 'null'
          maxLength: 40
        imagingVendor:
          type:
          - string
          - 'null'
          maxLength: 40
        fileExtension:
          type:
          - string
          - 'null'
          maxLength: 40
        createdAt:
          type:
          - string
          - 'null'
          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))?$
      required:
      - id
    ImagingDocumentConfigTokenDto:
      type: object
      properties:
        token:
          type: string
        expiryTime:
          type: string
          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))?$
        documentIdentifier:
          type: string
        documentType:
          type: string
        documentUrl:
          type: string
    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'
    ImagingDocumentConfigTokenRequestBody:
      type: object
      properties:
        expiresIn:
          type: integer
  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/