API Documentation
Member API Object
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.
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 |