User Object

The user object is included in the Create and Update User endpoints and is included in some webhook callbacks when referring to driver and dispatch events.

Request Data

Below is a list of parameters you can send as part of the user object, for example, when sending the Create User request.

Read our Data Formatting article for more details about how different parameter types, such as datetime, are formatted and used in Bringg.

ParameterDescription
admin
boolean
Indicates if the user has administrative privileges.
dispatcher
boolean
Indicates if the user is a dispatcher.
company_id
string
Bringg's ID for the group of users within a team. See Get Companies.
company_external_id
string
Your external system's ID for the group of users within a team. See Get Companies.
crew_external_id
string
Your external system's ID for the driver's delivery crew, used to coordinate meetups and floating helper tasks during planned routes.
driver
boolean
Indicates if the user is a driver.
email
string
The user's email.
emergency_contact_name
string
Name of emergency contact (for use with the Rapid SOS application).
emergency_contact_phone
string
Phone number of emergency contact (for use with the Rapid SOS application).
external_id
string
The unique identifier for the user in your external system.
external_team_ids
array of strings
An array of your external system's IDs for the teams to which the user belongs.
home_address
string
The address of the user's "home" base, usually a warehouse or store location.
home_lat
number
The latitude of the user's "home" base.
home_lng
number
The longitude of the user's "home" base.
language
string
The user's preferred language.
name
string
The user's name.
phone
string
The user's phone number.
privilege_id
integer
The ID of the dispatcher or driver's Privileges group, which associates a dispatcher user with a set of authorization flags.
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.
team_ids
array of strings
The IDs of the teams to which the user belongs.
user_type_external_id
string
The driver user role ID in your external systems. Can be used instead of user_type_id.
user_type_id
integer
The ID of the user type within Bringg.

Response & Webhook Data

Parameter

Description

*success**
boolean

Indicates whether the service completed successfully.

false - the service failed. true - the service succeeded

*message**
string

If an error occurred, a message indicating the error is included.

*rc**
integer

If an error occurred, the return code is included.

*access_token**
string

The access token for the user.

*active_shift_id**
integer

The ID of the driver's current shift.

*active_team_id**
integer

The ID of the team the driver is currently assigned to.

*admin**
boolean

Indicates if the user has administrative privileges.

*allowed_user_types**
array

*app_id**
string

The ID of the mobile app the user is using.

*at_home**
boolean

Indicates whether the driver is located at their "home" base, usually a store or warehouse.

*authentication_token**
string

The authentication token for the user.

*authorization_flags**
json

An object containing user privileges.

*average_rating**
number

The average rating the driver has received.

*battery**
integer

The current battery level of the user's device.

*beta**
boolean

Indicates if the user is part of a beta program.

*blocked_email**
boolean

Indicates whether this user's email is blocked. The values are:

  • falseor0* - user's email is not blocked
  • trueor1* - user's email is blocked
    The default value is false.

*can_impersonate**
boolean

*company_id**
integer

Bringg's ID for the group of users within a team. See Get Companies .

*company**
integer

The name of the company.

*confirmation_code**
integer

The confirmation code sent to this user's phone for login verification.

*confirmation_code_sent_at**
datetime

The timestamp when the confirmation code allowing the new user to login was sent.

*confirmed_at**
datetime

*created_at**
datetime

The timestamp when the user was created. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".

*crew_id**
integer

Bringg's ID for the driver's delivery crew, used to coordinate meetups and floating helper tasks during planned routes.

*current_task_id**
integer

The ID of the order the driver is actively fulfilling.

*current_unavailability_id**
integer

The ID of the user's current unavailability status.

*current_vehicle_id**
integer

The ID of the vehicle currently assigned to the user.

*customer**
boolean

*default_user_activity**
integer

The user's default activity. The values are:

  • 0* - unknown
  • 1* - stationary
  • 2* - walking
  • 3* - running
  • 4* - bicycle
  • 5* - driving
    The default values is 5.

*default_welcome_url_id**
string

*delete_at**
datetime

The date and time this user was deleted, if the user was deleted. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

*device_model**
string

The model of the user's mobile device.

*dispatcher**
boolean

Indicates if the user is a driver.

*dispatcher_push_token**
string

*driver**
boolean

Indicates whether this user is a Bringg driver. The values are:

  • falseor0* - the user is not an driver
  • trueor1* - the user is an driver

*driver_current_sign_in_at**
datetime

The timestamp of the driver's current sign-in. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".

*driver_last_sign_in_at**
datetime

The timestamp of the driver's last sign-in. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".

*driver_sign_in_count**
integer

The number of times the driver has signed in.

*email**
string

The user's email.

*email_hash**
string

The hash of the user's email.

*emergency_contact_name**
string

Name of emergency contact (for use with the Rapid SOS application).

*emergency_contact_phone**
string

Phone number of emergency contact (for use with the Rapid SOS application).

*estimated_last_address**
string

The last known address of the user using approximation based on last or next delivery.

*estimated_last_etl**
string

The estimated time of leaving the last known order location (ETA plus time on site). This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".

*estimated_last_lat**
string

The last known latitude of the user using approximation based on last or next delivery.

*estimated_last_lng**
string

The last known longitude of the user using approximation based on last or next delivery.

*estimated_last_waypoint_id**
string

The Id of the last known way point for the user using approximation based on last or next delivery.

*eta_to_home**
datetime

The estimated time of arrival to the driver's "home" base.

*external_driver**
boolean

Indicates whether the user belongs to an external carrier.

*external_id**
string

The unique identifier for the user in your external system.

*extras**
string

*feature_flags**
array of integers

*fleet_id**
string

If this user is assigned to an external fleet, this is the Id of that external fleet.

*force_change_password_date**
datetime

The date and time of this user will be required to change passwords. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

*force_change_password_token**
string

The token for this user's required change of passwords.

*home_address**
string

The address of the user's "home" base, usually a warehouse or store location.

*home_lat**
number

The latitude of the user's "home" base.

*home_lng**
number

The longitude of the user's "home" base.

*id**
integer

The unique identifier of the user.

*in_beacon_range**
boolean

Indicates whether the user is in range of a known beacon.

  • falseor0* - the user is not in range of a beacon
  • trueor1* - the user is in range of a beacon

*job_description**
string

The user's job description.

*language**
string

The user's preferred language in the Bringg UI. This is a 2-letter code. For example, "en" for English or "fr" for French. This is only relevant for Dispatcher and Admin users who log into the Bringg dashboard.

*last_logs_requested_at**
datetime

The timestamp when the user's logs were last requested.

*last_parking_started_at**
datetime

*last_parking_stopped_at**
datetime

*last_sign_in_at**
datetime

The timestamp of the driver's last sign-in.

*lat**
number

The latitude of the user's last reported location.

*lng**
number

The longitude of the user's last reported location.

*locked**
boolean

*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.

*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.

*name**
string

The user's name.

*num_ratings**
integer

The number of ratings the driver has received.

*original_phone_number**
string

The original phone number of this user, if the phone number was changed.

*original_user_id**
integer

The original Id of this user, if the Id was changed.

*os_version**
string

The operating system version of the driver's mobile device.

*partner_user**
boolean

*password_hash**
string

The hash of the user's password.

*phone**
string

The user's phone number.

*phone_hash**
string

The hash of the user's phone number.

*private_vehicle**
boolean

Indicates whether the driver uses their own vehicle to determine if mileage should be compensated.

  • falseor0* - the user does use a private vehicle
  • trueor1* - the user does not use a private vehicle

*privilege_id**
integer

The ID of the dispatcher or driver's Privileges group, which associates a dispatcher user with a set of authorization flags.

*profile_image**
string

The URL of the user's profile image.

*push_token**
string

The push token for the user's device.

*rank**
integer

*running_diagnostics**
boolean

*service_area_id**
integer

*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.

*status**
string

The user's status. The possible values are: Free, Assigned, Started, Checked-In, Late, Offline

*sub**
string

The sub status of the user. The maximum length is 255 characters.

*team_ids**
array of integers

An array of Bringg IDs for the teams to which the user belongs.

*team_external_ids**
array of strings

An array of your system's IDs for the teams to which the user belongs.

*updated_at**
datetime

The last date and time this user was updated. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".

*uploaded_profile_image**
string

*user_type_id**
integer

The ID of the user type within Bringg.

*uuid**
string

The universal unique Id of this user.

*vehicle_id**
integer

The ID of the vehicle associated with this user.

*vehicle_skills**
array of strings