Trimble User Fields Data API

Retrieves, and updates User Field entries for a specified type. User fields of order and order interliner can be viewed in the Customer Service application. User fields of trip carrier can be viewed in the Dispatch or Multi Mode Dispatch applications. The user field configuration can be viewed in the the Codes Maintenance application > Custom Defined Fields tab> User Fields sub-tab.

GitHub OpenAPI

Operations 2

GET /userFieldsData Retrieve user fields #
PUT /userFieldsData Update a user field information #

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-userfieldsdata-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-userfieldsdata-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: TruckMate REST User Fields Data 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: userFieldsData
  description: Retrieves, and updates User Field entries for a specified type. User fields of order and order interliner can be viewed in the Customer Service application. User fields of trip carrier can be viewed in the Dispatch or Multi Mode Dispatch applications. The user field configuration can be viewed in the the Codes Maintenance application > Custom Defined Fields tab> User Fields sub-tab.
paths:
  /userFieldsData:
    get:
      summary: Retrieve user fields
      description: 'Retrieves user field records for the specified source type.


        User fields for an order can be viewed in the Customer Service application > User Def''s.


        User fields for a pickup request can be viewed in the Order Preprocessor application > User Defined.


        User fields for an order interliner can be viewed in the Customer Service application > I/P tab > User Fields.


        User fields for a trip carrier can be viewed in the Dispatch or Multi Mode Dispatch applications.


        **Dispatch**


        * Trips grid > shortcut menu > Carrier Operations > Carrier > Carrier Information window > User Fields tab


        **Multi Mode Dispatch**


        * Trip Legs grid > shortcut menu > Carriers > Carrier Assign > Carrier Information window > User Fields tab'
      operationId: GetUserFieldsDatas
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - userFieldsData
      parameters:
      - $ref: '#/components/parameters/sourceType'
      - name: sourceId
        in: query
        description: Specifies an identifier for the source
        required: false
        schema:
          type: string
      - name: userField
        in: query
        description: Specifies a user field
        required: false
        schema:
          type: integer
      - name: userData
        in: query
        description: Search for user field data that contains the provided value.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserFieldsDatas200'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    put:
      summary: Update a user field information
      description: 'Updates a user field record for the specified source type.


        User fields for an order can be viewed in the Customer Service application > User Def''s.


        User fields for a pickup request can be viewed in the Order Preprocessor application > User Defined.


        User fields for an order interliner can be viewed in the Customer Service application > I/P tab > User Fields.


        User fields for a trip carrier can be viewed in the Dispatch or Multi Mode Dispatch applications.


        **Dispatch**


        * Trips grid > shortcut menu > Carrier Operations > Carrier > Carrier Information window > User Fields tab


        **Multi Mode Dispatch**


        * Trip Legs grid > shortcut menu > Carriers > Carrier Assign > Carrier Information window > User Fields tab'
      operationId: PutUserFieldsData
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - userFieldsData
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutUserFieldDataRequest'
      parameters:
      - $ref: '#/components/parameters/sourceType'
      - name: sourceId
        in: query
        description: Specifies an identifier for the source
        required: true
        schema:
          type: string
      - name: userField
        in: query
        description: Specifies a user field
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/userFieldData'
        '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'
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
    sourceType:
      name: sourceType
      in: query
      description: Specify the type of user fields
      required: true
      style: form
      explode: true
      schema:
        type: string
        enum:
        - orderInterliner
        - tripCarrier
        - order
        - pickupRequest
    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:
    GetUserFieldsDatas200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        count:
          type: integer
        userFieldsData:
          type: array
          items:
            $ref: '#/components/schemas/userFieldData'
    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
    userFieldData:
      type: object
      properties:
        userField:
          type: integer
          minimum: 1
          maximum: 20
        data:
          oneOf:
          - type: string
          - type: number
        sourceId:
          oneOf:
          - type: string
          - type: number
    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'
    PutUserFieldDataRequest:
      type: object
      properties:
        data:
          oneOf:
          - type: string
          - type: number
  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/