Show All Teams

Use to return all the teams for a merchant.

Note: This endpoint does not require input parameters.

Response (Output) Params

> 📘 The output is an array of team objects.

ParameterDescription
*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.
*allow_access_to_all_open_tasks**
boolean

Indicates whether drivers receive unassigned tasks.

false - the drivers do not receive unassigned tasks.
true - the drivers do receive unassigned tasks.

*address**
string
The first line of the address associated with the team.
*address_second_line**
string
The second line of the address associated with the team. e.g. "1st floor", "Apartment 5a".
*beacon_ids**
array of strings
An array of beacon IDs associated with the team.
*city**
string
The city where the team is located.
*contact_phone**
string
The contact phone number associated with this team.
*country_code**
string
The two-letter ISO country code of the team’s location.
*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".
*default_customer_id**
int64
The default customer ID for the team.
*default_task_configuration_id**
int64
*default_user_id**
int64
The default user (driver) ID for the team.
*delete_at**
datetime
The timestamp when the team was deleted.
*description**
string
Additional details about the team.
*distance_pay_per_km**
float
The cost per kilometer for the team.
*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
Your system's ID for the team.
*extra**
object
Internal use.
*extras**
object
Internal use.
*franchisee_id**
int64
The Bringg ID for the related franchisee.
*geohash**
string
The geohash (public domain geocoding system hash) of this team.
*home_area**
object
An object containing the home area for this team.
*id**
int64
The unique identifier of the team.
*lat**
float
The geoposition latitude of the team's address.
*lng**
float
The geoposition longitude of the team's address.
*merchant_id**
int32
The ID of the merchant to which the team belongs.
*name**
string
The name of the team, such as a store or area.
*parent_team_id**
int64
The ID of the parent team associated with this team.
*printer_type**
string
The type of printer used to print receipts. The values are:
3"
A4
*required_coc_type**
string
The required chain of custody type. The values include:
  • 0* - weak
  • 1* - strong
  • 2* - none
  • 3* - unload
*service_boroughs**
array of strings
An array of boroughs serviced by the team.
*service_cities**
array of strings
An array of cities serviced by the team.
*service_zipcodes**
array of strings
An array of ZIP codes serviced by the team.
*state**
string
The state where the team is located.
*street**
string
The street where the team is located.
*task_invoice_template_name**
string
*team_type**
string
*time_zone**
string
The time zone of the team.
*updated_at**
datetime
The last date and time this team was updated. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".
*web_site**
string
The website URL associated with the team.
*zipcode**
string
The ZIP code of the team's location.
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json