> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Member API Object

> Properties of the Member (Person) object. Here you can find detailed information on each property, its data type, read/write permissions, and a brief description.

The Member object represents a person/user in your HelloTracks organization. This includes field workers, dispatchers, and administrators.

<Note>
  **Creating Members:** Use [/createaccount](/api-reference/endpoint/createaccount) endpoint\
  **Editing Members:** Use [/editaccount](/api-reference/endpoint/editaccount) endpoint\
  **Getting Members:** Use [/getaccounts](/api-reference/endpoint/getaccounts) endpoint
</Note>

<Note>
  The R/W column below refers to the `/api` member endpoints. The public REST `/v1/members` endpoints use a smaller camelCase request schema and do not accept every writable `/api` field.
</Note>

## 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                                  |
| email           | 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 | RW  | Array of team IDs (numbers) the user belongs to. Use [Get Company](/api-reference/endpoint/getcompany) to map IDs to team names. |
| 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 | RW  | Working hours for each day of week (see structure below) |
| working\_hours\_overrides         | OBJECT | RW  | Date-specific working-hours overrides                    |
| ignore\_working\_hours\_until\_ts | LONG   | RW  | 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 | RW  | Whether two-factor authentication is enabled   |
| google\_calendar         | BOOLEAN | R   | 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         |

**Example:**

```json theme={null}
{
  "monday": { "start": 480, "end": 1020 },
  "tuesday": { "start": 480, "end": 1020 },
  "wednesday": { "start": 0, "end": 0 },
  "source": "individual"
}
```

*Note: `start: 0` and `end: 0` indicates a day off*

### working\_hours\_overrides Object

Working-hours overrides are keyed by date in `YYYYMMDD` format. Each value contains `start` and `end` in minutes from midnight:

```json theme={null}
{
  "20260629": { "start": 540, "end": 900 }
}
```

<ResponseExample>
  ```json Example theme={null}
  {
  "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
  }
  ```
</ResponseExample>