Creating Members: Use /createaccount endpoint
Editing Members: Use /editaccount endpoint
Getting Members: Use /getaccounts endpoint
Editing Members: Use /editaccount endpoint
Getting Members: Use /getaccounts endpoint
Core Properties
| Property | Type | R/W | Description |
|---|---|---|---|
| id | TEXT | R | Unique identifier (same as uid) |
| uid | TEXT | R | The user’s unique identifier |
| username | TEXT | R | The username/email address for login |
| name | TEXT | RW | The display name of the user |
| TEXT | RW | The user’s email address | |
| email_verified | BOOLEAN | R | Whether the user’s email has been verified |
| phone | TEXT | RW | The user’s phone number |
| phone_verified | BOOLEAN | R | Whether the user’s phone number has been verified |
| type | TEXT | R | Always “person” for member objects |
| color | TEXT | RW | Designated color code in hexadecimal format (e.g., “#22c328”) |
| portrait | TEXT | R | URL to the user’s portrait/avatar image thumbnail |
| portrait_ts | LONG | R | Timestamp when portrait was last updated |
Role & Permissions
| Property | Type | R/W | Description |
|---|---|---|---|
| role | TEXT | RW | User role: “worker”, “operator” (dispatcher), or “admin” (superuser) |
| active_status | TEXT | R | Account status if not normal (e.g., suspended, deactivated) |
| teams | ARRAY | R | Array of team IDs (numbers) the user belongs to |
| scim_data | TEXT | RW | SCIM provisioning data (for enterprise SSO integrations) |
Location & Tracking
| Property | Type | R/W | Description |
|---|---|---|---|
| location | OBJECT | R | Current location object (see structure below) |
| states | OBJECT | R | Various state indicators (see structure below) |
| timestamps | OBJECT | R | Important timestamps (see structure below) |
| battery_level | INTEGER | R | Current device battery level (0-100 percentage) |
| battery_plugged | BOOLEAN | R | Whether device is plugged into power source |
| status_label | TEXT | RW | Custom status label (e.g., “On Break”, “Vacation”) |
| status_label_ts | LONG | R | Timestamp when status label was last updated |
| current_trip_id | TEXT | R | ID of currently active trip (if any) |
Route & Navigation
| Property | Type | R/W | Description |
|---|---|---|---|
| route_start_lat | DOUBLE | RW | Latitude of route start location |
| route_start_lng | DOUBLE | RW | Longitude of route start location |
| route_end_lat | DOUBLE | RW | Latitude of route end location |
| route_end_lng | DOUBLE | RW | Longitude of route end location |
| route_start_time | INTEGER | RW | Route start time (HHMM format), -1 if using team default |
| travel_mode | TEXT | RW | Mode of travel: “car”, “bicycle”, “pedestrian”, “truck”, “van”, “motorcycle” |
| vehicle_capacity | INTEGER | RW | Capacity of vehicle for pickup/dropoff calculations |
Working Hours & Availability
| Property | Type | R/W | Description |
|---|---|---|---|
| working_hours | OBJECT | R | Working hours for each day of week (see structure below) |
| ignore_working_hours_until_ts | LONG | R | Timestamp until which working hours are ignored |
Localization & Preferences
| Property | Type | R/W | Description |
|---|---|---|---|
| language | TEXT | RW | Language preference (ISO code, e.g., “en”, “de”, “es”) |
| timezone | TEXT | RW | Timezone (region/city format, e.g., “Europe/Vienna”, “America/New_York”) |
| unit_distance | TEXT | RW | Distance unit system: “SI” (metric) or “US” (imperial) |
| unit_time | TEXT | RW | Time format: “12” or “24” hour |
| unit_date | TEXT | RW | Date format pattern (e.g., “dd.MM.yyyy”, “MM/dd/yyyy”) |
Skills & Capabilities
| Property | Type | R/W | Description |
|---|---|---|---|
| skills | ARRAY | RW | Array of skill tags for job matching (JSON array string) |
| expertise | TEXT | RW | Expertise level or description |
Device Information
| Property | Type | R/W | Description |
|---|---|---|---|
| device | OBJECT | R | Device details object (see structure below) |
Security & Authentication
| Property | Type | R/W | Description |
|---|---|---|---|
| twofactor_auth_enabled | BOOLEAN | R | Whether two-factor authentication is enabled |
| google_calendar | BOOLEAN | RW | Whether Google Calendar integration is enabled |
Nested Object Structures
location Object
| Field | Type | Description |
|---|---|---|
| lat | DOUBLE | Latitude |
| lng | DOUBLE | Longitude |
| ts | LONG | Timestamp of location fix (milliseconds) |
| head | INTEGER | Heading/bearing in degrees (0-360) |
| accuracy | INTEGER | Location accuracy in meters |
| speed | INTEGER | Speed in m/s |
states Object
| Field | Type | Description |
|---|---|---|
| moving | TEXT | Movement state: “halted”, “idling”, “ontheway”, “offduty” |
| tracking_status | BOOLEAN | Whether tracking is currently active |
| location_services | BOOLEAN | Whether device location services are enabled |
| login_status | BOOLEAN | Whether user is currently logged in to app |
| battery_save | BOOLEAN | Whether battery save mode is active |
| off_trackrecording | BOOLEAN | Whether track recording is disabled |
| ignoring_battery_optimization | BOOLEAN | Whether app ignores battery optimization |
| off_gps_stationary | BOOLEAN | Whether GPS is off while stationary |
| location_permission | BOOLEAN | Whether app has location permissions |
timestamps Object
| Field | Type | Description |
|---|---|---|
| signal | LONG | Last signal/heartbeat timestamp |
| created | LONG | Account creation timestamp |
| login | LONG | Last login status change timestamp |
| sync | LONG | Last app sync timestamp |
| tracking | LONG | Last tracking status change timestamp |
| suspended | LONG | Device suspension timestamp (if applicable) |
| recovered | LONG | Device recovery timestamp (if applicable) |
device Object
| Field | Type | Description |
|---|---|---|
| model | TEXT | Device model (e.g., “Pixel 7a”) |
| manufacturer | TEXT | Device manufacturer (e.g., “Google”) |
| os | TEXT | Operating system (e.g., “Android 14”, “iOS 17”) |
| app_launches | INTEGER | Number of times app has been launched |
| app_version | INTEGER | App version number (internal) |
| app_version_name | TEXT | App version name (e.g., “7.3.3”) |
| id | TEXT | Unique device identifier |
| mode | INTEGER | Device mode (tracking configuration) |
| diagnostics_path | TEXT | Path to diagnostics file (if available) |
| name | TEXT | Custom device name (if set) |
working_hours Object
Each day (monday-sunday) contains:| Field | Type | Description |
|---|---|---|
| start | INTEGER | Start time in minutes from midnight (e.g., 480 = 8:00 AM) |
| end | INTEGER | End time in minutes from midnight (e.g., 1020 = 5:00 PM) |
| source | TEXT | ”individual” or “team” indicating source of hours |
start: 0 and end: 0 indicates a day off