API Documentation
Member API Object
Properties of the Member object. Here you can find detailed information on each property, its data type, read/write permissions, and a brief description.
{
"status_label_ts":1668530288557,
"role":"admin",
"color":"#22c328",
"route_start_lng":9.56416,
"route_start_time":-1,
"timezone":"Europe/Vienna",
"timestamps":{
"created":1334218991087,
"login":1699521431189,
"signal":1699521425482,
"tracking":1699259010889
},
"language":"en",
"vehicle_capacity":0,
"type":"person",
"states":{
"login_status":false,
"location_services":true,
"battery_save":false,
"tracking_status":true,
"off_trackrecording":false,
"location_permission":true,
"moving":"halted",
"off_gps_stationary":false
},
"uid":"je7oc8",
"route_start_lat":47.2574,
"id":"je7oc8",
"unit_date":"dd.MM.yyyy",
"email":"mario.bertschler@gmx.at",
"email_verified":true,
"battery_level":89,
"teams":[
1
],
"battery_plugged":false,
"portrait":"https://hellotracks.com/img/accounts/je7oc8/portrait_1699259050905_thumb.jpg",
"twofactor_auth_enabled":false,
"google_calendar":false,
"unit_time":"12",
"status_label":" Vacation",
"route_end_lat":47.2574,
"unit_distance":"SI",
"phone_verified":true,
"travel_mode":"car",
"phone":"+436608277299",
"working_hours":{
"sunday":{
"start":300,
"end":2130
},
"saturday":{
"start":300,
"end":2130
},
"tuesday":{
"start":300,
"end":2130
},
"wednesday":{
"start":300,
"end":2130
},
"thursday":{
"start":0,
"end":0
},
"friday":{
"start":300,
"end":2130
},
"source":"individual",
"monday":{
"start":300,
"end":2130
}
},
"name":"D Bernoulli",
"location":{
"head":243,
"lng":9.60521,
"accuracy":96,
"lat":47.24949,
"speed":2,
"ts":1699472445000
},
"device":{
"mode":1,
"diagnostics_path":"/img/attachments/cubt5w/diagnostics/394e496e-760d-4342-b95f-ec4d4c135d15.json",
"os":"Android 14",
"app_version":245,
"model":"Pixel 7a",
"id":"31e85970b571139d",
"app_launches":3,
"app_version_name":"7.3.3",
"manufacturer":"Google"
},
"username":"daniel.bernoulli.ts",
"route_end_lng":9.56416
}
Member API Object
Property | Type | R/W | Description | |
---|---|---|---|---|
battery_level | INTEGER | R | The current battery level of the device in percentage | |
battery_plugged | BOOLEAN | R | Indicates if the device is plugged into a power source | |
color | STRING | R | The designated color code in hexadecimal format | |
device | OBJECT | R | Object containing details about the device such as OS, model, app version, etc. | |
STRING | W | The user’s email address | ||
email_verified | BOOLEAN | R | Indicates whether the user’s email is verified | |
google_calendar | BOOLEAN | R | Indicates if Google Calendar integration is enabled | |
id | TEXT | R | Unique identifier, similar to ‘uid’ | |
language | STRING | R | The language setting of the user, represented in ISO code | |
location | OBJECT | R | Object containing the current location details such as latitude, longitude, speed, etc. | |
location_services | BOOLEAN | R | Indicates if location services are enabled on the device | |
login_status | BOOLEAN | R | Indicates the user’s current login status | |
name | STRING | W | The name of the user | |
phone | STRING | W | The user’s phone number | |
phone_verified | BOOLEAN | R | Indicates whether the user’s phone number is verified | |
portrait | STRING | R | URL to the user’s portrait image | |
role | STRING | R | The role of the user within the system (e.g., admin) | |
states | OBJECT | R | Object containing various state indicators like tracking status, battery save mode, etc. | |
status_label | STRING | W | Label indicating the current status of the user (e.g., ‘Vacation’) | |
status_label_ts | INTEGER | R | Timestamp of when the status label was last updated | |
teams | ARRAY | R | Array containing team IDs the user is a part of | |
timezone | STRING | R | The timezone of the user, represented in a region/city format | |
travel_mode | STRING | R | The mode of travel used by the user (e.g., car) | |
twofactor_auth_enabled | BOOLEAN | R | Indicates if two-factor authentication is enabled | |
type | STRING | R | The type of the entity, in this case ‘person’ | |
uid | TEXT | R | The user’s unique identifier | |
unit_date | STRING | R | Format used for displaying dates (e.g., ‘dd.MM.yyyy’) | |
unit_distance | STRING | R | Unit system used for measuring distance (e.g., ‘SI’ for metric system) | |
unit_time | STRING | R | Format used for displaying time (e.g., ‘12’ for 12-hour format) | |
username | STRING | R | The username associated with the user | |
vehicle_capacity | INTEGER | R | The capacity of the vehicle used by the user, ‘0’ may indicate not applicable or not set | |
working_hours | OBJECT | R | Object containing the working hours for each day of the week, including start and end times in minutes |
{
"status_label_ts":1668530288557,
"role":"admin",
"color":"#22c328",
"route_start_lng":9.56416,
"route_start_time":-1,
"timezone":"Europe/Vienna",
"timestamps":{
"created":1334218991087,
"login":1699521431189,
"signal":1699521425482,
"tracking":1699259010889
},
"language":"en",
"vehicle_capacity":0,
"type":"person",
"states":{
"login_status":false,
"location_services":true,
"battery_save":false,
"tracking_status":true,
"off_trackrecording":false,
"location_permission":true,
"moving":"halted",
"off_gps_stationary":false
},
"uid":"je7oc8",
"route_start_lat":47.2574,
"id":"je7oc8",
"unit_date":"dd.MM.yyyy",
"email":"mario.bertschler@gmx.at",
"email_verified":true,
"battery_level":89,
"teams":[
1
],
"battery_plugged":false,
"portrait":"https://hellotracks.com/img/accounts/je7oc8/portrait_1699259050905_thumb.jpg",
"twofactor_auth_enabled":false,
"google_calendar":false,
"unit_time":"12",
"status_label":" Vacation",
"route_end_lat":47.2574,
"unit_distance":"SI",
"phone_verified":true,
"travel_mode":"car",
"phone":"+436608277299",
"working_hours":{
"sunday":{
"start":300,
"end":2130
},
"saturday":{
"start":300,
"end":2130
},
"tuesday":{
"start":300,
"end":2130
},
"wednesday":{
"start":300,
"end":2130
},
"thursday":{
"start":0,
"end":0
},
"friday":{
"start":300,
"end":2130
},
"source":"individual",
"monday":{
"start":300,
"end":2130
}
},
"name":"D Bernoulli",
"location":{
"head":243,
"lng":9.60521,
"accuracy":96,
"lat":47.24949,
"speed":2,
"ts":1699472445000
},
"device":{
"mode":1,
"diagnostics_path":"/img/attachments/cubt5w/diagnostics/394e496e-760d-4342-b95f-ec4d4c135d15.json",
"os":"Android 14",
"app_version":245,
"model":"Pixel 7a",
"id":"31e85970b571139d",
"app_launches":3,
"app_version_name":"7.3.3",
"manufacturer":"Google"
},
"username":"daniel.bernoulli.ts",
"route_end_lng":9.56416
}