get https://developer-api.bringg.com/services/49193007//
Get the details of a user (driver, dispatcher, or admin) using their external_id or Bringg id.
Please Note:
Either
idorexternal_idneeds to be provided.
Using External ID
If you are going to get details of a user by External ID, you need to make sure that these values are unique.
Response (Output) Params
| Parameter | Description |
|---|---|
access_tokenstring | The access token for the user. |
active_shift_idinteger | The ID of the driver's current shift. |
authentication_tokenstring | The authentication token for the user. |
active_team_idinteger | The ID of the team the driver is currently assigned to. |
at_homeboolean | Indicates whether the driver is located at their "home" base, usually a store or warehouse. |
average_ratingnumber | The average rating the driver has received. |
app_idstring | The ID of the mobile app the user is using. |
batteryinteger | The current battery level of the user's device. |
confirmation_code_sent_atdatetime | The timestamp when the confirmation code allowing the new user to login was sent. |
created_atdatetime | The timestamp when the user was created. |
current_task_idinteger | The ID of the order the driver is actively fulfilling. |
current_vehicle_idinteger | The ID of the vehicle currently assigned to the user. |
current_unavailability_idinteger | The ID of the user's current unavailability status. |
device_modelstring | The model of the user's mobile device. |
driver_current_sign_in_atdatetime | The timestamp of the driver's current sign-in. |
driver_last_sign_in_atdatetime | The timestamp of the driver's last sign-in. |
driver_sign_in_countinteger | The number of times the driver has signed in. |
eta_to_homedatetime | The estimated time of arrival to the driver's "home" base. |
mobile_typestring | The type of mobile device the user is using. |
mobile_versionstring | The version of the mobile app the user is using. |
team_external_idsarray of strings | An array of your external system's IDs for the teams to which the user belongs. |
private_vehicleboolean | Indicates whether the driver uses their own vehicle to determine if mileage should be compensated. |
skillsarray of strings | Driver capabilities, such as installation. Bringg matches these skills with the required_skills parameter to automatically assign routes to the most suitable driver based on their capabilities. |
betaboolean | Indicates if the user is part of a beta program. |
emailstring | The user's email. |
email_hashstring | The hash of the user's email. |
idinteger | The unique identifier of the user. |
job_descriptionstring | The user's job description. |
last_logs_requested_atdatetime | The timestamp when the user's logs were last requested. |
latnumber | The latitude of the user's last reported location. |
lngnumber | The longitude of the user's last reported location. |
merchant_idinteger | The ID of the merchant to which the user belongs. |
mobile_configurationobject | The saved settings for the driver's mobile app. |
namestring | The user's name. |
num_ratingsinteger | The number of ratings the driver has received. |
os_versionstring | The operating system version of the driver's mobile device. |
phone_hashstring | The hash of the user's phone number. |
password_hashstring | The hash of the user's password. |
profile_imagestring | The URL of the user's profile image. |
push_tokenstring | The push token for the user's device. |