Trimble Web Address Book API

Retrieves, creates and updates TM4Web address book entries. TM4WEB address book entries can be viewed in the TruckMate Web Administration program > Client Features > Contacts tab > Address Book sub-tab. The TM4Web address book allows customers to provide contact addresses to their web users which may not yet be clients configured within TruckMate's Customer Profile application. These non-existent contacts should be reviewed in the Order Preprocessor program at which time the employee can decide if the contact already exists in Customer Profiles and change it to this, or if this is a new contact and needs to be added.

GitHub OpenAPI

Operations 6

GET /webAddressBook Retrieve TM4WEB address book entries #
POST /webAddressBook Create a TM4WEB address book entry #
GET /webAddressBook/{webAddressBookId} Retrieve a specific TM4WEB address book entry #
PUT /webAddressBook/{webAddressBookId} Edit an existing TM4WEB address book entry #
DELETE /webAddressBook/{webAddressBookId} Delete an existing TM4WEB address book entry #
POST /webAddressBook/bulk Create TM4WEB address book entries in bulk #

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-address-book-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-address-book-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: TruckMate REST Web Address Book 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 Address Book
  description: Retrieves, creates and updates TM4Web address book entries. TM4WEB address book entries can be viewed in the TruckMate Web Administration program > Client Features > Contacts tab > Address Book sub-tab. The TM4Web address book allows customers to provide contact addresses to their web users which may not yet be clients configured within TruckMate's Customer Profile application. These non-existent contacts should be reviewed in the Order Preprocessor program at which time the employee can decide if the contact already exists in Customer Profiles and change it to this, or if this is a new contact and needs to be added.
paths:
  /webAddressBook:
    get:
      summary: Retrieve TM4WEB address book entries
      description: Retrieves an array of TM4WEB address book entries. Use the optional limit and offset query parameters to page through the resulting sets of data.
      operationId: GetWebAddressBooks
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Web Address Book
      parameters:
      - name: $filter
        in: query
        description: Filter query string for retrieving specific resources from the collection. Follows a subset of oData query syntax.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sort query string for ordering the resulting set of resources. Follows a subset of oData query syntax.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebAddressBooks200'
        '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 address book entry
      description: Creates a new TM4WEB address book entry. When using a TruckMate API key for authentication, the access code value is required. When using TM4Web credentials for authentication the access code will be set based on the web user.
      operationId: PostWebAddressBooks
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Web Address Book
      requestBody:
        description: A single JSON object containing the properties of the new TM4Web address book entry to be created.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebAddressBookRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webAddressBook'
        '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'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /webAddressBook/{webAddressBookId}:
    parameters:
    - name: webAddressBookId
      in: path
      description: web address book identifier
      required: true
      schema:
        type: integer
    get:
      summary: Retrieve a specific TM4WEB address book entry
      description: Retrieves an existing TM4WEB address book entry as specified by the web address book identifier path parameter.
      operationId: GetWebAddressBook
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Web Address Book
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webAddressBook'
                - 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'
        '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'
    put:
      summary: Edit an existing TM4WEB address book entry
      description: Updates one or more properties of an existing TM4WEB address book entry. Can be used for partial updates as only the properties sent in the request will be updated.
      operationId: PutWebAddressBook
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Web Address Book
      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/WebAddressBookPutRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webAddressBook'
        '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'
    delete:
      summary: Delete an existing TM4WEB address book entry
      description: Deletes an existing TM4WEB address book entry as specified by the web address book identifier path parameter.
      operationId: DeleteWebAddressBook
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      tags:
      - Web Address Book
      responses:
        '204':
          description: No Content
        '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'
  /webAddressBook/bulk:
    post:
      summary: Create TM4WEB address book entries in bulk
      description: Creates multiple new TM4WEB address book entries in a single atomic transaction. Limited to 50 entries per request. Only available to internal (non-web) users. When using a TruckMate API key for authentication, the access code value is required in each entry. If any entry fails validation, the entire operation is rolled back.
      operationId: PostWebAddressBooksBulk
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - Web Address Book
      requestBody:
        description: An array of JSON objects, each containing the properties of a new TM4Web address book entry to be created. Maximum 50 entries.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebAddressBookBulkRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostWebAddressBooksBulk201'
        '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'
        '409':
          description: Conflict
          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:
    webAddressBook:
      type: object
      properties:
        webAddressBookId:
          type: integer
        clientId:
          type: string
          maxLength: 10
        accessCode:
          type: string
          maxLength: 15
        appliesTo:
          type: string
          maxLength: 10
        name:
          type: string
          maxLength: 40
        emailAddress:
          type: string
          maxLength: 128
          oneOf:
          - enum:
            - ''
          - format: email
        address1:
          type: string
          maxLength: 40
        address2:
          type: string
          maxLength: 40
        city:
          type: string
          maxLength: 30
        province:
          type: string
          maxLength: 4
        country:
          type: string
          maxLength: 20
        postalCode:
          type: string
          maxLength: 10
        contact:
          type: string
          maxLength: 30
        businessPhone:
          type: string
          maxLength: 20
        businessFax:
          type: string
          maxLength: 20
        businessCell:
          type: string
          maxLength: 20
        currencyCode:
          type: string
          maxLength: 3
        favorite:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        zone:
          type: string
          maxLength: 10
        oeIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        oeIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        oeIsConsignee:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        rqIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        rqIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        rqIsConsignee:
          type: string
          enum:
          - 'False'
          - '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
    WebAddressBookPutRequest:
      type: object
      properties:
        appliesTo:
          type: string
          maxLength: 10
        name:
          type: string
          maxLength: 40
        emailAddress:
          type: string
          format: email
          maxLength: 128
        address1:
          type: string
          maxLength: 40
        address2:
          type: string
          maxLength: 40
        city:
          type: string
          maxLength: 30
        province:
          type: string
          maxLength: 4
        country:
          type: string
          maxLength: 20
        postalCode:
          type: string
          maxLength: 10
        contact:
          type: string
          maxLength: 30
        businessPhone:
          type: string
          maxLength: 20
        businessFax:
          type: string
          maxLength: 20
        businessCell:
          type: string
          maxLength: 20
        currencyCode:
          type: string
          maxLength: 3
        favorite:
          type: string
          enum:
          - 'False'
          - 'True'
        zone:
          type: string
          maxLength: 10
        oeIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
        oeIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
        oeIsConsignee:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsConsignee:
          type: string
          enum:
          - 'False'
          - 'True'
    WebAddressBookBulkItemRequest:
      type: object
      properties:
        clientId:
          type: string
          maxLength: 10
        accessCode:
          type: string
          description: Required. The access code for the address book entry.
          maxLength: 15
        appliesTo:
          type: string
          maxLength: 10
        name:
          type: string
          maxLength: 40
        emailAddress:
          type: string
          format: email
          maxLength: 128
        address1:
          type: string
          maxLength: 40
        address2:
          type: string
          maxLength: 40
        city:
          type: string
          maxLength: 30
        province:
          type: string
          maxLength: 4
        country:
          type: string
          maxLength: 20
        postalCode:
          type: string
          maxLength: 10
        contact:
          type: string
          maxLength: 30
        businessPhone:
          type: string
          maxLength: 20
        businessFax:
          type: string
          maxLength: 20
        businessCell:
          type: string
          maxLength: 20
        currencyCode:
          type: string
          maxLength: 3
        favorite:
          type: string
          enum:
          - 'False'
          - 'True'
        zone:
          type: string
          maxLength: 10
        oeIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
        oeIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
        oeIsConsignee:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsConsignee:
          type: string
          enum:
          - 'False'
          - 'True'
      required:
      - accessCode
    PostWebAddressBooksBulk201:
      type: object
      properties:
        webAddressBook:
          type: array
          items:
            $ref: '#/components/schemas/webAddressBook'
    WebAddressBookBulkRequest:
      type: object
      properties:
        webAddressBook:
          type: array
          items:
            $ref: '#/components/schemas/WebAddressBookBulkItemRequest'
    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'
    GetWebAddressBooks200:
      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
        count:
          type: integer
        webAddressBook:
          type: array
          items:
            $ref: '#/components/schemas/webAddressBook'
    WebAddressBookRequest:
      type: object
      properties:
        clientId:
          type: string
          maxLength: 10
        accessCode:
          type: string
          description: Required if using Truckmate API key Ignored if using the JWT API key. In this case, accessCode will be taken from the JWT user's accessCode
          maxLength: 15
        appliesTo:
          type: string
          maxLength: 10
        name:
          type: string
          maxLength: 40
        emailAddress:
          type: string
          format: email
          maxLength: 128
        address1:
          type: string
          maxLength: 40
        address2:
          type: string
          maxLength: 40
        city:
          type: string
          maxLength: 30
        province:
          type: string
          maxLength: 4
        country:
          type: string
          maxLength: 20
        postalCode:
          type: string
          maxLength: 10
        contact:
          type: string
          maxLength: 30
        businessPhone:
          type: string
          maxLength: 20
        businessFax:
          type: string
          maxLength: 20
        businessCell:
          type: string
          maxLength: 20
        currencyCode:
          type: string
          maxLength: 3
        favorite:
          type: string
          enum:
          - 'False'
          - 'True'
        zone:
          type: string
          maxLength: 10
        oeIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
        oeIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
        oeIsConsignee:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsCaller:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsShipper:
          type: string
          enum:
          - 'False'
          - 'True'
        rqIsConsignee:
          type: string
          enum:
          - 'False'
          - 'True'
  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/