An object representing an employee.
A word on the word "employee"
We use the word "employee" a bit loosely here. An "employee" in our system is anybody employed in any way by the company, including contractors, volunteers, or 'other' employee types.
Attributes | JSON Type | Description |
---|---|---|
| Integer | Unique identifier representing the employee for this account. |
| String | Email address. Required upon creation. |
| String | Legal first name. Required upon creation. |
| String | Legal middle name. |
| String | Legal last name. Required upon creation. |
|
| Birthdate. |
| String | Primary phone number. Must be between 7-14 digits. Only numbers, parentheses, hyphens, and spaces are accepted. |
|
| Primary (home) address. |
| String | Single-character representation of the employee's gender ("M", "F", or "X"). |
| String | An alternate or preferred name for the employee. |
|
| US-based social security number. |
| Integer | The number of seasons or number of years this employee worked for you prior to be added to WorkBright. This field is used to calculate overall tenure. |
|
| List of groups this employee belongs to. |
|
| Employment details. |
| String | The employee's designation in the system. One of: |
|
| List of values for each custom field. |
|
| Standard fields used by ADP WorkForce Now Integration and/or Background Check integration |
| String | Timestamp when record was last updated. |
| String | Timestamp of last log in, null if never signed in. |
| Boolean | If true, the latest email to this employee was not delivered properly. |
| Array of Strings | List of Remote I-9 notification methods for employee: |
| Array of Strings | List of Onboarding notification methods for employee: |
| Integer | ID of the E-Verify account for this employee's I-9 submission. If not set, uses the primary E-Verify account or the selected account during countersign. |
| String | The latest status of SMS notifications. One of: |
| Boolean | If |
| Boolean | If |