Employee
A person in your workforce: who they are, which team and organization they belong to, and whether their account is active. Employees are what journey plans are assigned to, what geofences apply to, and what GPS tracking is recorded against.
Stored in the EMPLOYEE layer.
Fields
| Field | Required | What it is |
|---|---|---|
employee_full_name | Yes | Full name of the employee |
employee_email | Yes | Must be a valid email and unique in the tenant |
employee_phone | International format, unique in the tenant | |
employee_dob | Date of birth | |
employee_username | Login name. This is also what other records reference - a plan assignee or a geofence assignment. A customer owner (customer_assignee) is referenced by employee_guid instead | |
employee_team_id | Yes | The team the employee belongs to |
employee_organization_id | Yes | The organization the employee belongs to |
employee_reporting_manager | Username of the manager this employee reports to | |
employee_role | ReportingManager or Worker | |
employee_grade_id | Grade of the employee | |
employee_vehicle_id | Vehicle assigned to the employee | |
employee_image | Photograph of the employee | |
employee_code | Assigned by the platform, not sent on create | |
employee_guid | Assigned by the platform. This is the id the enable and disable calls take | |
employee_status | Lifecycle state, set by the platform: 1 new, 2 inactive, 3 active, 4 disabled |
Values and formats
The same field comes back in two shapes. Endpoints that read a record raw - create, and GET .../detail - return the stored codes. Search endpoints resolve references to their display label, and hand you the raw value in a __keyfield twin:
| Field | Create / detail | Search |
|---|---|---|
employee_status | "3" | "Active" |
employee_role | "Worker", "ReportingManager" | "Team Member", "Team Manager" |
employee_team_id | "2" | "SovereignSolutions", plus employee_team_id__keyfield: "2" |
employee_organization_id | "1" | "demo" |
Match on the code, not the label: labels are tenant configuration and change without notice. Where a __keyfield twin exists, that is the value to store.
