Search for a specific user
get/v1/users/lookup
Request
- Base URLhttps://api.gomotive.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
emailstring
Specify the email address of the user.
usernamestring
Specify the username of the user that you are searching for.
driver_company_idstring
Specify the driver's company ID. NOTE: This parameter is only applicable for drivers.
phonestring
Enter the user's phone number.
Headers
X-Time-Zonestring
Specify the timezone for formatting the timestamps.
X-Metric-Unitsboolean
Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units
X-User-Idinteger
Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.
Response
200
Example response
{
"user": {
"id": 294979,
"first_name": "John",
"last_name": "Connor",
"time_zone": "Pacific Time (US & Canada)",
"carrier_name": "Demo Carrier",
"carrier_street": "415 Truckin St.",
"carrier_city": "San Francisco",
"carrier_state": "CA",
"carrier_zip": "94105",
"violation_alerts": "1_hour",
"terminal_street": "350 Sansome St",
"terminal_city": "San Francisco",
"terminal_state": "CA",
"terminal_zip": "94104",
"cycle": "70_8",
"export_combined": true,
"export_recap": true,
"export_odometers": true,
"username": "demo_driver_1_kt3647454",
"minute_logs": true,
"duty_status": "off_duty",
"eld_mode": "logs",
"yard_moves_enabled": true,
"personal_conveyance_enabled": true,
"role": "driver",
"status": "active",
"created_at": "2016-08-09T00:43:40Z",
"updated_at": "2017-04-20T21:08:32.134197Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.