Identify a company using its access token

Purpose: The purpose of this endpoint is to identify a company, by using an access token. To use the access token, you must first generate one.

Below are the steps for generating an access token:


Response Parameters

companies

  • Type: Array of Objects
  • Description: Contains the list of companies.

company

  • Type: Object
  • Description: Details of a single company.

id

  • Type: Integer
  • Description: The unique identifier of the company.

company_id

  • Type: String
  • Description: The system-generated or custom identifier for the company.

name

  • Type: String
  • Description: The name of the company.

street

  • Type: String
  • Description: The street address of the company.

city

  • Type: String
  • Description: The city where the company is located.

state

  • Type: String
  • Description: The state or region where the company is located.

zip

  • Type: String
  • Description: The ZIP or postal code of the company.

dot_ids

  • Type: Array
  • Description: A list of DOT (Department of Transportation) IDs associated with the company.

cycle

  • Type: String
  • Description: The cycle setting used for Hours of Service (HOS) or similar regulations.

time_zone

  • Type: String
  • Description: The time zone the company operates in.

exception_24_hour_restart

  • Type: Boolean
  • Description: Indicates whether the company allows a 24-hour restart exception.

exception_8_hour_break

  • Type: Boolean
  • Description: Indicates whether the company allows an 8-hour break exception.

exception_wait_time

  • Type: Boolean
  • Description: Indicates whether the company applies a wait time exception.

exception_short_haul

  • Type: Boolean
  • Description: Indicates whether the company applies a short haul exception.

exception_ca_farm_school_bus

  • Type: Boolean
  • Description: Indicates whether the company applies the California farm/school bus exception.

exception_adverse_driving

  • Type: Boolean
  • Description: Indicates whether the company allows an adverse driving condition exception.

metric_units

  • Type: Boolean
  • Description: Indicates whether the company uses metric units.

minute_logs

  • Type: Boolean
  • Description: Indicates whether the company uses minute-by-minute logging.

subscription_plan

  • Type: String
  • Description: The subscription plan associated with the company.

Language
Credentials
Header
Click Try It! to start a request and see the response here!