API Reference
Log In

List all the users of a company

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

Purpose: Use this API to fetch a list of all the users that belong to your company. The users can be having any of the following roles:

  • Driver
  • Fleet User
  • Admin

If you are looking for driver info, you can also narrow the search, by specifying the driver status or the user status in the query parameters. Refer to the Query Parameters section for more info.

Response Parameters

users

  • Type: Array of Objects
  • Description: List of users.

user:

  • Type: Object

  • Description: Details of a user.

id:

  • Type: Integer
  • Description: Unique identifier of the user.

email:

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

first_name:

  • Type: String
  • Description: User's first name.

last_name:

  • Type: String
  • Description: User's last name.

company_reference_id:

  • Type: String
  • Description: Reference ID for the company associated with the user.

phone:

  • Type: String
  • Description: Phone number of the user.

phone_ext:

  • Type: String
  • Description: Phone extension of the user.

time_zone:

  • Type: String
  • Description: Time zone of the user.

carrier_name:

  • Type: String
  • Description: Name of the carrier company.

carrier_street:

  • Type: String
  • Description: Street address of the carrier company.

carrier_city:

  • Type: String
  • Description: City where the carrier company is located.

carrier_state:

  • Type: String
  • Description: State where the carrier company is located.

carrier_zip:

  • Type: String
  • Description: ZIP code of the carrier company.

violation_alerts:

  • Type: String
  • Description: Frequency of violation alerts (e.g., "1_hour").

terminal_street:

  • Type: String
  • Description: Street address of the terminal.

terminal_city:

  • Type: String
  • Description: City where the terminal is located.

terminal_state:

  • Type: String
  • Description: State where the terminal is located.

terminal_zip:

  • Type: String
  • Description: ZIP code of the terminal.

exception_24_hour_restart:

  • Type: Boolean
  • Description: Indicates if the 24-hour restart exception is applied.

exception_8_hour_break:

  • Type: Boolean
  • Description: Indicates if the 8-hour break exception is applied.

exception_wait_time:

  • Type: Boolean
  • Description: Indicates if the wait time exception is applied.

exception_short_haul:

  • Type: Boolean
  • Description: Indicates if the short haul exception is applied.

exception_ca_farm_school_bus:

  • Type: Boolean
  • Description: Indicates if the CA farm school bus exception is applied.

cycle2:

  • Type: String
  • Description: Second cycle of the user.

exception_24_hour_restart2:

  • Type: Boolean
  • Description: Indicates if the 24-hour restart exception is applied to the second cycle.

exception_8_hour_break2:

  • Type: Boolean
  • Description: Indicates if the 8-hour break exception is applied to the second cycle.

exception_wait_time2:

  • Type: Boolean
  • Description: Indicates if the wait time exception is applied to the second cycle.

exception_short_haul2:

  • Type: Boolean
  • Description: Indicates if the short haul exception is applied to the second cycle.

exception_ca_farm_school_bus2:

  • Type: Boolean
  • Description: Indicates if the CA farm school bus exception is applied to the second cycle.

export_combined:

  • Type: Boolean
  • Description: Indicates if the data export is combined.

export_recap:

  • Type: Boolean
  • Description: Indicates if the recap data is exported.

export_odometers:

  • Type: Boolean
  • Description: Indicates if odometer readings are exported.

metric_units:

  • Type: Boolean
  • Description: Indicates if metric units are used.

username:

  • Type: String
  • Description: Username of the user.

cycle:

  • Type: String
  • Description: Cycle type of the user (e.g., "70_8").

driver_company_id:

  • Type: String
  • Description: Company ID of the driver.

minute_logs:

  • Type: Boolean
  • Description: Indicates if minute logs are enabled.

duty_status:

  • Type: String
  • Description: Current duty status of the user (e.g., "off_duty").

eld_mode:

  • Type: String
  • Description: The mode of the Vehicle Gateway (e.g., "logs").

drivers_license_number:

  • Type: String
  • Description: Driver's license number of the user.

drivers_license_state:

  • Type: String
  • Description: State of the user's driver's license.

yard_moves_enabled:

  • Type: Boolean
  • Description: Indicates if yard moves are enabled.

personal_conveyance_enabled:

  • Type: Boolean
  • Description: Indicates if personal conveyance is enabled.

mobile_last_active_at:

  • Type: String
  • Description: Timestamp when the user was last active on mobile.

mobile_current_sign_in_at:

  • Type: String
  • Description: Timestamp when the user last signed in on mobile.

mobile_last_sign_in_at:

  • Type: String
  • Description: Timestamp when the user last signed in on mobile.

web_last_active_at:

  • Type: String (ISO 8601 format)
  • Description: Timestamp when the user was last active on the web.

role:

  • Type: String
  • Description: Role of the user (e.g., "driver").

status:

  • Type: String
  • Description: Status of the user (e.g., "active").

web_current_sign_in_at:

  • Type: String
  • Description: Timestamp when the user last signed in on the web.

web_last_sign_in_at:

  • Type: String
  • Description: Timestamp when the user last signed in on the web.

created_at:

  • Type: String
  • Description: Timestamp when the user was created.

updated_at:

  • Type: String
  • Description: Timestamp when the user was last updated.

external_ids:

  • Type: Array of Objects

  • Description: List of external IDs associated with the user.

external_id:

  • Type: String
  • Description: External ID of the user.

integration_name:

  • Type: String
  • Description: Name of the integration associated with the external ID (e.g., "generic_tms").
Language
Credentials
Header
Click Try It! to start a request and see the response here!