Trimble Status Codes API

Retrieves TruckMate status codes. Status codes can be viewed and maintained in the TruckMate Codes Maintenance application.

GitHub OpenAPI

Operations 8

GET /statusCodes Retrieve status codes #
GET /statusCodes/{statusCodeId} Retrieve a status code #
GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache Gets all Status Codes objects from the cache #
POST /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/search Search through Status Codes objects in the data cache #
GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/{ryvitId_value} Gets one Status Codes object from the cache #
GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/__ryvitId/{ryvitId_value} Gets one Status Codes object from the cache #
GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/keyid/{KeyID} Gets one Status Codes object from the cache #
GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/natural/{Status} Gets one Status Codes object from the cache #

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-status-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-status-codes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: MasterData Status Codes API
  description: 'The Master Data management API allows for an external system to create, retrieve, update or delete TruckMate configuration data, such as Client, Vendor and Driver profiles, as well as sites, zones, commodity codes etc.


    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: Status Codes
  description: Retrieves TruckMate status codes. Status codes can be viewed and maintained in the TruckMate Codes Maintenance application.
paths:
  /statusCodes:
    get:
      summary: Retrieve status codes
      description: 'Retrieve status code records.


        Status codes can be viewed in the Codes Maintenance application > Status Codes tab.'
      operationId: GetStatuses
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Status Codes
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/select'
      - name: codesByTripNumber
        in: query
        description: Retrieve next zone code or status code for a given trip number. The provided value must be a valid TruckMate status or zone code. If used to retrieve zone codes, must be used together with the tripNewStatus parameter.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStatuses200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /statusCodes/{statusCodeId}:
    parameters:
    - name: statusCodeId
      in: path
      description: status code identifier
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a status code
      description: 'Retrieve a status code record.


        Status codes can be viewed in the Codes Maintenance application > Status Codes tab.'
      operationId: GetStatus
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Status Codes
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/statusCode'
                - 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'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache:
    get:
      tags:
      - Status Codes
      summary: Gets all Status Codes objects from the cache
      description: 'Represents data found in Vista™ PM Status IDs.


        Vista view: PMSC'
      operationId: GET/direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache
      parameters:
      - $ref: '#/components/parameters/subscriber_code'
      - $ref: '#/components/parameters/X-Application-Key'
      - $ref: '#/components/parameters/limit_continuation'
      - $ref: '#/components/parameters/modifiedUTCSince'
      - $ref: '#/components/parameters/continuationToken'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                - limit
                - data
                - next
                - continuationToken
                type: object
                properties:
                  limit:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/data_status_codes_withKeys'
                  next:
                    type: string
                  continuationToken:
                    type: string
        '400':
          $ref: '#/components/responses/errorResponse'
        '401':
          $ref: '#/components/responses/unauth'
        '403':
          $ref: '#/components/responses/forbidden'
      x-operation-id-source: normalized
      x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache
  /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/search:
    post:
      tags:
      - Status Codes
      summary: Search through Status Codes objects in the data cache
      description: 'Represents data found in Vista™ PM Status IDs.


        Vista view: PMSC'
      operationId: POST/direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/search/search
      parameters:
      - $ref: '#/components/parameters/subscriber_code'
      - $ref: '#/components/parameters/X-Application-Key'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                modifiedUtcAfter:
                  maxLength: 28
                  minLength: 28
                  type: string
                  description: 'Returns objects that were modified after the specified date (ISO 8601 format).  Format: yyyy-MM-ddThh:mm:ss.fffffffZ.  Example ''2019-12-11T20:16:58.3419275Z''.  If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.'
                  format: date-time
                modifiedUtcBefore:
                  maxLength: 28
                  minLength: 28
                  type: string
                  description: 'Returns objects that were modified before the specified date (ISO 8601 format).  Format: yyyy-MM-ddThh:mm:ss.fffffffZ.  Example ''2019-12-11T20:16:58.3419275Z''.  If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.'
                  format: date-time
                continuationToken:
                  type: string
                  description: Supplying this token will result in retrieving the next chunk of data if the first request contained more than 100 (up to) records or greater than 1 megabyte in size.  On your first call, you must omit or provide an empty string.  On subsequent calls, provide the continuationToken from the previous result.
                filters:
                  type: array
                  items:
                    oneOf:
                    - required:
                      - propertyName
                      - value
                      - operator
                      type: object
                      properties:
                        propertyName:
                          type: string
                          description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter.  E.g. 'PONumber' or 'Sender.LastName'.
                        value:
                          type: integer
                          description: You must match the JSON type value to the propertyName JSON type.  There is no type coercion.
                        operator:
                          enum:
                          - Equal
                          - GreaterThan
                          - GreaterThanOrEqual
                          - LessThan
                          - LessThanOrEqual
                          - NotEqual
                          type: string
                      additionalProperties: false
                      description: ''
                    - required:
                      - propertyName
                      - value
                      - operator
                      type: object
                      properties:
                        propertyName:
                          type: string
                          description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter.  E.g. 'PONumber' or 'Sender.LastName'.
                        value:
                          type: string
                          description: You must match the JSON type value to the propertyName JSON type.  There is no type coercion.
                        operator:
                          enum:
                          - Equal
                          - GreaterThan
                          - GreaterThanOrEqual
                          - LessThan
                          - LessThanOrEqual
                          - NotEqual
                          - Like
                          - EndsWith
                          - StartsWith
                          - Contains
                          type: string
                      additionalProperties: false
                      description: ''
                    - required:
                      - propertyName
                      - value
                      - operator
                      type: object
                      properties:
                        propertyName:
                          type: string
                          description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter.  E.g. 'PONumber' or 'Sender.LastName'.
                        value:
                          type: boolean
                          description: You must match the JSON type value to the propertyName JSON type.  There is no type coercion.
                        operator:
                          enum:
                          - Equal
                          - NotEqual
                          type: string
                      additionalProperties: false
                      description: ''
                    - required:
                      - propertyName
                      - value
                      - operator
                      type: object
                      properties:
                        propertyName:
                          type: string
                          description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter.  E.g. 'PONumber' or 'Sender.LastName'.
                        value:
                          type: array
                          items:
                            oneOf:
                            - type: string
                            - type: number
                          description: ' This oneOf option is to be used for null values for all data types.  You must match the JSON type value to the propertyName JSON type.  There is no type coercion.'
                        operator:
                          enum:
                          - In
                          type: string
                      additionalProperties: false
                      description: ''
                  description: All provided filters are combined with AND conditions. E.g. filter1 AND filter2 AND filter3.  Not providing a filter will result in an unfiltered result.  Filtering can be performed on nested object properties but can not be performed on array item properties.  If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                - count
                - data
                type: object
                properties:
                  count:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/data_status_codes_withKeys'
                  continuationToken:
                    type: string
                    description: Supply this token on the next request to get the next chunk of data. This will have a value if the result set contains more than 100 records or the set is greater than 1 megabyte.
        '400':
          $ref: '#/components/responses/errorResponse'
        '401':
          $ref: '#/components/responses/unauth'
        '403':
          $ref: '#/components/responses/forbidden'
      x-operation-id-source: normalized
      x-operation-id-original: POST /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/search/search
  /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/{ryvitId_value}:
    get:
      tags:
      - Status Codes
      summary: Gets one Status Codes object from the cache
      description: 'Represents data found in Vista™ PM Status IDs.


        Vista view: PMSC'
      operationId: GET/direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/{ryvitId_value}
      parameters:
      - $ref: '#/components/parameters/subscriber_code'
      - $ref: '#/components/parameters/X-Application-Key'
      - name: ryvitId_value
        in: path
        description: The code of the data object you want to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_status_codes_withKeys'
        '401':
          $ref: '#/components/responses/unauth'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
      x-operation-id-source: normalized
      x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/{ryvitId_value}
  /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/__ryvitId/{ryvitId_value}:
    get:
      tags:
      - Status Codes
      summary: Gets one Status Codes object from the cache
      description: 'Represents data found in Vista™ PM Status IDs.


        Vista view: PMSC'
      operationId: GET/direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/__ryvitId/{ryvitId_value}
      parameters:
      - $ref: '#/components/parameters/subscriber_code'
      - $ref: '#/components/parameters/X-Application-Key'
      - name: ryvitId_value
        in: path
        description: The code of the data object you want to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_status_codes_withKeys'
        '401':
          $ref: '#/components/responses/unauth'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
      x-operation-id-source: normalized
      x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/__ryvitId/{ryvitId_value}
  /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/keyid/{KeyID}:
    get:
      tags:
      - Status Codes
      summary: Gets one Status Codes object from the cache
      description: 'Represents data found in Vista™ PM Status IDs.


        Vista view: PMSC'
      operationId: GET/direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/keyid/{KeyID}
      parameters:
      - $ref: '#/components/parameters/subscriber_code'
      - $ref: '#/components/parameters/X-Application-Key'
      - name: KeyID
        in: path
        description: The KeyID portion of the key used to identify the object.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_status_codes_withKeys'
        '401':
          $ref: '#/components/responses/unauth'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
      x-operation-id-source: normalized
      x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/keyid/{KeyID}
  /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/natural/{Status}:
    get:
      tags:
      - Status Codes
      summary: Gets one Status Codes object from the cache
      description: 'Represents data found in Vista™ PM Status IDs.


        Vista view: PMSC'
      operationId: GET/direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/natural/{Status}
      parameters:
      - $ref: '#/components/parameters/subscriber_code'
      - $ref: '#/components/parameters/X-Application-Key'
      - name: Status
        in: path
        description: The Status portion of the key used to identify the object.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data_status_codes_withKeys'
        '401':
          $ref: '#/components/responses/unauth'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFound'
      x-operation-id-source: normalized
      x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/pm/2/data/status_codes/cache/natural/{Status}
components:
  schemas:
    GetStatuses200:
      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
        statusCodes:
          type: array
          items:
            $ref: '#/components/schemas/statusCode'
    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
    statusCode:
      type: object
      properties:
        statusCode:
          type: string
          maxLength: 10
        codeBehavior:
          type: string
          enum:
          - administrative
          - arriveAtDock
          - arriveConsignee
          - arriveShipper
          - assignment
          - availability
          - cancel
          - completion
          - departConsignee
          - departDock
          - departShipper
          - dispatch
          - docked
          - entry
          - late
          - locked
          - other
          - spotting
          - terminal
          - unavailability
          - ''
        appliesTo:
          oneOf:
          - type: array
            items:
              type: string
              enum:
              - chassis
              - container
              - driver
              - freightBill
              - miscEquipment
              - powerUnit
              - trailer
              - trip
        isDefaultForCategory:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        previousCode:
          type: string
          maxLength: 10
        shortDescription:
          type: string
          maxLength: 30
        longDescription:
          type: string
          maxLength: 131072
        isActive:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        requireReasonCode:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        webEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        isDefaultNextStatusCode:
          type: string
          enum:
          - 'False'
          - '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'
    data_status_codes_withKeys:
      allOf:
      - type: object
        properties:
          __ryvitKeys:
            type: array
            items:
              type: string
            description: Array of key paths that can be used to retrieve this object.
            example:
            - keyid/{KeyID}
          __modifiedUTC:
            type: string
            description: UTC timestamp of when this object was last modified in the cache.
            example: '2020-01-01T13:01:01.1234567Z'
      - $ref: '#/components/schemas/data_status_codes'
    errorSchema:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  target:
                    title: Describes which field in the request has an issue.
                    type: string
                  message:
                    title: The error message describing the issue.
                    type: string
    data_status_codes:
      required:
      - Status
      - Description
      - CodeType
      - IncludeInProj
      - KeyID
      - ExcludeYN
      - ActiveAllYN
      type: object
      properties:
        Status:
          maxLength: 6
          type: string
          description: ''
        Description:
          maxLength: 30
          type: string
          description: ''
        CodeType:
          maxLength: 1
          type: string
          description: ''
        IncludeInProj:
          maxLength: 1
          type: string
          description: ''
        Notes:
          type:
          - string
          - 'null'
          description: ''
        UniqueAttchID:
          maxLength: 36
          minLength: 36
          pattern: '[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}'
          type:
          - string
          - 'null'
          description: ''
        KeyID:
          type: integer
          description: ''
        ExcludeYN:
          enum:
          - Y
          - N
          type: string
          description: ''
        ActiveAllYN:
          maxLength: 1
          type: string
          description: ''
        DocCat:
          maxLength: 10
          type:
          - string
          - 'null'
          description: ''
        __custom_fields:
          type: object
          description: This property will be added if there are any custom fields defined for this object in Vista.  Each custom field will be a property of this object.
  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
    X-Application-Key:
      name: X-Application-Key
      in: header
      description: Used to authorize access to the Direct API.
      required: true
      schema:
        type: string
    continuationToken:
      name: continuationToken
      in: query
      description: A URL Encoded continuationToken value from a previous GET response.  When provided, the next set of results for the original GET will be returned.
      schema:
        type: string
    subscriber_code:
      name: subscriber_code
      in: path
      description: The code of the subscriber that you are making this request for.
      required: true
      schema:
        type: string
    modifiedUTCSince:
      name: modifiedUTCSince
      in: query
      description: A string specifies a datetime against which to filter the results. When specified the result will be ordered oldest __modifiedUTC to newest.  Example 2019-12-11T20:16:58.3419275Z. Optional. If unspecified, all cached objects will be returned.
      schema:
        type: string
    limit_continuation:
      name: limit
      in: query
      description: Limits the number of records returned by the API, up to a maximum of 1,000.  The API may return less than the limit even when more records exist.  Always examine the 'next' and 'continuationToken' properties to determine if more records are available.
      schema:
        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
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
  responses:
    errorResponse:
      description: Describes issues with the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorSchema'
    unauth:
      description: You have not provided a proper X-Application-Key in the header of this request.
    notFound:
      description: The object with the given ID was not found OR a subscriber with the given URL was not found.
    forbidden:
      description: The X-Application-Key provided is valid but the key does not have access to this resource.
externalDocs:
  url: https://learn.transportation.trimble.com/