API Reference

Get User

Get the details of a user (driver, dispatcher, or admin) using their external_id or Bringg id.

📘

Please Note:

Either id or external_id needs 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
ParameterDescription
access_token
string
The access token for the user.
active_shift_id
integer
The ID of the driver's current shift.
authentication_token
string
The authentication token for the user.
active_team_id
integer
The ID of the team the driver is currently assigned to.
at_home
boolean
Indicates whether the driver is located at their "home" base, usually a store or warehouse.
average_rating
number
The average rating the driver has received.
app_id
string
The ID of the mobile app the user is using.
battery
integer
The current battery level of the user's device.
confirmation_code_sent_at
datetime
The timestamp when the confirmation code allowing the new user to login was sent.
created_at
datetime
The timestamp when the user was created.
current_task_id
integer
The ID of the order the driver is actively fulfilling.
current_vehicle_id
integer
The ID of the vehicle currently assigned to the user.
current_unavailability_id
integer
The ID of the user's current unavailability status.
device_model
string
The model of the user's mobile device.
driver_current_sign_in_at
datetime
The timestamp of the driver's current sign-in.
driver_last_sign_in_at
datetime
The timestamp of the driver's last sign-in.
driver_sign_in_count
integer
The number of times the driver has signed in.
eta_to_home
datetime
The estimated time of arrival to the driver's "home" base.
mobile_type
string
The type of mobile device the user is using.
mobile_version
string
The version of the mobile app the user is using.
team_external_ids
array of strings
An array of your external system's IDs for the teams to which the user belongs.
private_vehicle
boolean
Indicates whether the driver uses their own vehicle to determine if mileage should be compensated.
skills
array 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.
beta
boolean
Indicates if the user is part of a beta program.
email
string
The user's email.
email_hash
string
The hash of the user's email.
id
integer
The unique identifier of the user.
job_description
string
The user's job description.
last_logs_requested_at
datetime
The timestamp when the user's logs were last requested.
lat
number
The latitude of the user's last reported location.
lng
number
The longitude of the user's last reported location.
merchant_id
integer
The ID of the merchant to which the user belongs.
mobile_configuration
object
The saved settings for the driver's mobile app.
name
string
The user's name.
num_ratings
integer
The number of ratings the driver has received.
os_version
string
The operating system version of the driver's mobile device.
phone_hash
string
The hash of the user's phone number.
password_hash
string
The hash of the user's password.
profile_image
string
The URL of the user's profile image.
push_token
string
The push token for the user's device.

Language