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.

Parameter	Description
`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

Below is a list of the data returned in webhooks and responses to your API requests. The inclusion of specific parameters may depend on your use case, your API request, and the webhook fields you have subscribed to.

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: false or 0 - user's email is not blocked true or 1 - 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.
`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: false or 0 - the user is not an driver true or 1 - the user is an driver
`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.
`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 is in 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. false or 0 - the user is not in range of a beacon true or 1 - 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. false or 0 - the user does use a private vehicle true or 1 - 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
`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}