API Reference
Log In

List all the company assets

get https://api.gomotive.com/v1/assets

Purpose: Use this API to fetch a list of all the company's assets.

📘

NOTE

In case you want a specific asset to be listed, mention the Name and the Status of that particular asset in the query parameter. Refer to the Query Parameter section for more info.

require 'uri'
require 'net/http'

url = URI('https://api.gomotive.com/v1/assets')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Authorization'] = "Bearer <OAUTH_TOKEN>"

response = http.request(request)
puts response.read_body

Response Parameters

id

  • Type: Integer
  • Description: The unique identifier for the asset.

name

  • Type: String
  • Description: The name assigned to the asset.

status

  • Type: String
  • Description: The current status of the asset (e.g., "active").

type

  • Type: String
  • Description: The type of asset, such as "low_boy".

custom_type

  • Type: String
  • Description: Custom type of the asset, if applicable. Default is null.

vin

  • Type: String
  • Description: Vehicle Identification Number (VIN) of the asset. Default is null.

license_plate_state

  • Type: String
  • Description: The state where the asset’s license plate is registered. Default is null.

license_plate_number

  • Type: String
  • Description: The license plate number of the asset. Default is null.

make

  • Type: String
  • Description: The manufacturer of the asset.

model

  • Type: String
  • Description: The model of the asset.

year

  • Type: String
  • Description: The year the asset was manufactured.

axle

  • Type: Integer
  • Description: Number of axles on the asset. Default is null.

weight_metric_units

  • Type: Boolean
  • Description: Indicates whether the asset’s weight is measured in metric units.

length_metric_units

  • Type: Boolean
  • Description: Indicates whether the asset’s length is measured in metric units.

leased

  • Type: Boolean
  • Description: Indicates whether the asset is leased. Default is null.

notes

  • Type: String
  • Description: Additional notes or information about the asset. Default is null.

length

  • Type: Float
  • Description: The length of the asset. Default is null.

gvwr

  • Type: Float
  • Description: Gross Vehicle Weight Rating (GVWR) of the asset. Default is null.

gawr

  • Type: Float
  • Description: Gross Axle Weight Rating (GAWR) of the asset. Default is null.

asset_gateway.id

  • Type: Integer
  • Description: The unique identifier for the asset's gateway device.

asset_gateway.identifier

  • Type: String
  • Description: The identifier of the asset's gateway device.

asset_gateway.active

  • Type: Boolean
  • Description: Indicates whether the asset's gateway device is active.

external_ids

  • Type: Array
  • Description: An array containing external identifiers associated with the asset. Default is an empty array.

availability_details

  • Type: Object
  • Description: Contains the availability details object. This object denotes the availability of the asset for a dispatch.

availability_status

  • Type: String
  • Description: Denotes the availability status of the asset. Allowed values are “out_of_service” or “in_service”.

out_of_service_reason

  • Type: String
  • Description: Denotes the reason for the asset being out of service.

updated_at

  • Type: DateTime
  • Description: Denotes the date and time when the availability status of the asset was updated.

additional_note

  • Type: String
  • Description: Denotes any comments or notes added for updating the availability of the asset. For example, “This asset is scheduled for maintenance.”

custom_driver_app_warning_prompt

  • Type: String
  • Description: This denotes the prompt message that drivers see on their driver_app. This prompt can be used to inform the driver about the status of the asset or communicate any specific instructions. For example, “Asset is under maintenance, do not operate.”

updated_by_user

  • Type: Object
  • Description: Object containing the details of the user who updated the availability status of the asset.

id

  • Type: Int
  • Description: The ID of the user who updated the availability status of the asset.

first_name

  • Type: String
  • Description: First name of the user who updated the status of the asset.

last_name

  • Type: String
  • Description: Last name of the user who updated the status of the asset.

user_name

  • Type: String
  • Description: Company username of the person who updated the status.

email

  • Type: String
  • Description: Email address of the user.

company_reference_id

  • Type: Int
  • Description: The company ID of the user as per the internal company records.

status

  • Type: String
  • Description: The status of the user who updated the availability of the asset.

role

  • Type: String
  • Description: The role of the user who updated the availability status of the asset.
Language
Credentials
Header
Click Try It! to start a request and see the response here!