Employee object

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

id

Integer

Unique identifier representing the employee for this account.

email

String

Email address. Required upon creation.

first_name

String

Legal first name. Required upon creation.

middle_name

String

Legal middle name.

last_name

String

Legal last name. Required upon creation.

birthdate

  • String_ (format: YYYY-MM-DD)

Birthdate.

phone

String

Primary phone number. Must be between 7-14 digits. Only numbers, parentheses, hyphens, and spaces are accepted.

address

Primary (home) address.

gender

String

Single-character representation of the employee's gender ("M", "F", or "X").

nickname

String

An alternate or preferred name for the employee.

ssn

  • String_ (format: 000-00-0000, regex: ^[0-9]{3}-[0-9]{2}-[0-9]{4}$)

US-based social security number.

untracked_prior_tenure

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.

groups

List of groups this employee belongs to.

employment

Employment details.

employee_type

String

The employee's designation in the system. One of: employee, contractor or other . See *Employee Types *.

custom_fields

List of values for each custom field.

standard_fields

  • Arrayof _StandardField objects

Standard fields used by ADP WorkForce Now Integration and/or Background Check integration

updated_at

String
(format: ISO 8601)

Timestamp when record was last updated.

last_sign_in_at

String
(format: ISO 8601)

Timestamp of last log in, null if never signed in.

undelivered_email

Boolean

If true, the latest email to this employee was not delivered properly.

ri9_notification_methods

Array of Strings

List of Remote I-9 notification methods for employee: ["email"], ["sms"] or null.

onboarding_notification_methods

Array of Strings

List of Onboarding notification methods for employee: ["email"], ["sms"] or null.

default_everify_account_id

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.

sms_status

String

The latest status of SMS notifications. One of:
opt_out or failed or null. Defaults to null if not sent or if successful. If Employee opts out of SMS notifications this will be set to opt_out. If an SMS notification fails to deliver, this will be set to failed.

applied_for_ssn

Boolean

If true, means the employee has applied for a Social Security Number and as such should not have their I-9 submitted to E-Verify until their SSN has been entered. Defaults to false.

skip_everify

Boolean

If truemeans the employee's I-9 will not be sent to E-Verify.