Search for a specific user

Purpose: Use this API to search for a specific user and see their information.

📘

NOTE

This API requires you to specify any one of the following as a query parameter: Refer to the Query Parameters section for more info.

• Email
• User Name
• Driver's Company ID
• Phone

Response Parameters

id

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

email

• Type: String
• Description: User's email address.

first_name

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

last_name

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

phone

• Type: String
• Description: User's phone number.

phone_ext

• Type: String
• Description: Phone extension.

time_zone

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

metric_units

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

carrier_name

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

carrier_street

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

carrier_city

• Type: String
• Description: City of the carrier.

carrier_state

• Type: String
• Description: State of the carrier.

carrier_zip

• Type: String
• Description: Zip code of the carrier.

violation_alerts

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

terminal_street

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

terminal_city

• Type: String
• Description: City of the terminal.

terminal_state

• Type: String
• Description: State of the terminal.

terminal_zip

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

cycle

• Type: String
• Description: Cycle type associated with the user.

exception_24_hour_restart

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

exception_8_hour_break

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

exception_wait_time

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

exception_short_haul

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

exception_ca_farm_school_bus

• Type: Boolean
• Description: Indicates if the California farm school bus exception is enabled.

cycle2

• Type: String
• Description: Secondary cycle type.

exception_24_hour_restart2

• Type: Boolean
• Description: Indicates if the 24-hour restart exception is enabled (secondary).

exception_8_hour_break2

• Type: Boolean
• Description: Indicates if the 8-hour break exception is enabled (secondary).

exception_wait_time2

• Type: Boolean
• Description: Indicates if the wait time exception is enabled (secondary).

exception_short_haul2

• Type: Boolean
• Description: Indicates if the short haul exception is enabled (secondary).

exception_ca_farm_school_bus2

• Type: Boolean
• Description: Indicates if the California farm school bus exception is enabled (secondary).

export_combined

• Type: Boolean
• Description: Indicates if combined export is enabled.

export_recap

• Type: Boolean
• Description: Indicates if recap export is enabled.

export_odometers

• Type: Boolean
• Description: Indicates if odometer export is enabled.

username

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

driver_company_id

• Type: String
• Description: Driver's company ID.

minute_logs

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

duty_status

• Type: String
• Description: Current duty status of the user.

eld_mode

• Type: String
• Description: ELD mode of the user.

drivers_license_number

• Type: String
• Description: Driver's license number.

drivers_license_state

• Type: String
• Description: State where the driver's license was issued.

yard_moves_enabled

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

personal_conveyance_enabled

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

manual_driving_enabled

• Type: Boolean
• Description: Indicates if manual driving is enabled.

role

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

status

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

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
• Description: External IDs associated with the user.

---