Trimble Web Access Codes API

Retrieves per-access-code group options (Address Book permissions) for TruckMate Web Access Codes. The relatedIds, webUsers and addressBookClients collections can be retrieved with the $expand query parameter.

GitHub OpenAPI

Operations 2

GET /webAccessCodes Retrieve web access codes #
GET /webAccessCodes/{accessCode} Retrieve a web access code #

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-access-codes-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-access-codes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: TruckMate REST Web Access Codes 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 Access Codes
  description: Retrieves per-access-code group options (Address Book permissions) for TruckMate Web Access Codes. The relatedIds, webUsers and addressBookClients collections can be retrieved with the $expand query parameter.
paths:
  /webAccessCodes:
    get:
      summary: Retrieve web access codes
      description: 'Retrieves web access code records with their address-book permission settings.


        The relatedIds, webUsers and addressBookClients collections can be retrieved with the $expand query parameter.


        This endpoint is available only to internal TruckMate authentication methods (TID JWT and TruckMate API key). TM4Web users are not permitted to access this endpoint.'
      operationId: GetWebAccessCodes
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - Web Access Codes
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - relatedIds
            - webUsers
            - addressBookClients
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebAccessCodes200'
        '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'
  /webAccessCodes/{accessCode}:
    parameters:
    - name: accessCode
      in: path
      description: Web access code identifier
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a web access code
      description: 'Retrieves the specified web access code record with its address-book permission settings.


        The relatedIds, webUsers and addressBookClients collections can be retrieved with the $expand query parameter.


        This endpoint is available only to internal TruckMate authentication methods (TID JWT and TruckMate API key). TM4Web users are not permitted to access this endpoint.'
      operationId: GetWebAccessCode
      security:
      - tidJwtAuth: []
      - truckmateApiKeyAuth: []
      tags:
      - Web Access Codes
      parameters:
      - $ref: '#/components/parameters/select'
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - relatedIds
            - webUsers
            - addressBookClients
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webAccessCodes'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '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:
    webAccessCodeAddressBookClient:
      type: object
      properties:
        clientId:
          type: string
          maxLength: 10
        webAddressBookId:
          type: integer
        appliesTo:
          type:
          - string
          - 'null'
          maxLength: 10
        email:
          type:
          - string
          - 'null'
          maxLength: 128
          oneOf:
          - enum:
            - ''
          - format: email
        favorite:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
    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'
    webAccessCodes:
      type: object
      properties:
        accessCode:
          type:
          - string
          - 'null'
          maxLength: 15
        addressBookCanAdd:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        addressBookCanUpdateDelete:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        relatedIds:
          type: array
          items:
            $ref: '#/components/schemas/webAccessCodeRelatedId'
        webUsers:
          type: array
          items:
            $ref: '#/components/schemas/webAccessCodeWebUser'
        addressBookClients:
          type: array
          items:
            $ref: '#/components/schemas/webAccessCodeAddressBookClient'
    webAccessCodeRelatedId:
      type: object
      properties:
        relatedId:
          type: string
          maxLength: 20
        userType:
          type:
          - string
          - 'null'
          maxLength: 10
    GetWebAccessCodes200:
      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
        webAccessCodes:
          type: array
          items:
            $ref: '#/components/schemas/webAccessCodes'
    webAccessCodeWebUser:
      type: object
      properties:
        username:
          type:
          - string
          - 'null'
          maxLength: 128
        isActive:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        enabled:
          type:
          - string
          - 'null'
          enum:
          - 'False'
          - 'True'
          - ''
          - null
        email:
          type:
          - string
          - 'null'
          maxLength: 128
          oneOf:
          - enum:
            - ''
          - format: email
  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
    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
    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
    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
  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/