Rippling: Employee API schemas
8 Rippling schemas with complete fields and constraints.
← Employee API operations · All schemas
GET Employee — employee Api get Employees Employee Id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An employee model object. |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
address (anyOf 1).city | string | Optional | |
address (anyOf 1).country | string | Optional | |
address (anyOf 1).state | string | Optional | |
address (anyOf 1).streetLine1 | string | Optional | |
address (anyOf 1).zip | string | Optional | |
address (anyOf 2) | null | Alternative | |
companyEmploymentType | Model | Optional | Expand GET Employee — employee Api get Employees Employee Id — response body — company Employment Type |
compensation | Model | Optional | Expand GET Employees — employee Api get Employees — response body — compensation |
createdAt | string | Optional | When the row was created |
customFields | Model | Optional | Expand GET Custom Fields — response body — item |
department | string | Optional | The employee's department name |
departmentId | string | Optional | The unique identifier of the employee's department |
dob | string | Optional | Date of birth |
ein | string | Optional | The employee identifier number |
employeeNumber | JSON | Optional | |
employeeNumber (anyOf 1) | string | Alternative | The employee number |
employeeNumber (anyOf 2) | JSON | Alternative | |
employeeNumber (anyOf 2) (anyOf 1) | integer | Alternative | |
employeeNumber (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
employmentType | string | Optional | An ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured. Known values: CONTRACTOR, SALARIED_FT, SALARIED_PT, HOURLY_FT, HOURLY_PT, TEMP |
endDate | JSON | Optional | |
endDate (anyOf 1) | string | Alternative | The employee's end date. Will only return information after the employee's termination. |
endDate (anyOf 2) | null | Alternative | |
entityId | string | Optional | The legal entity ID the employee is employed on |
filingStatus | JSON | Optional | |
filingStatus (anyOf 1) | string | Alternative | An ENUM of Filing Status Known values: SINGLE, MARRIED, MARRIED_USER_SINGLE_RATE |
filingStatus (anyOf 2) | null | Alternative | |
firstName | string | Optional | First name of the employee |
flsaStatus | string | Optional | The employee's FLSA status stating whether they are exempt or non-exempt Known values: exempt, non-exempt |
gender | JSON | Optional | |
gender (anyOf 1) | string | Alternative | The employee's gender Known values: MALE, FEMALE |
gender (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1) | object | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).annualLimit | string | Optional | Known values: INDIVIDUAL, FAMILY, NULL |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 1) | string | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 1) | string | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).status | string | Optional | Known values: ENROLLED, NOT_ENROLLED, NOT_OFFERED, PENDING_ENROLLMENT |
hsaCompatiblePlanStatus (anyOf 2) | null | Alternative | |
id | string | Optional | This is the unique role ID of the employee. A role ID exists per 1 and only 1 company. |
identifiedGender | JSON | Optional | |
identifiedGender (anyOf 1) | string | Alternative | The employee's identified gender |
identifiedGender (anyOf 2) | null | Alternative | |
internationalBankAccount | JSON | Optional | |
internationalBankAccount (anyOf 1) | string | Alternative | The international bank account |
internationalBankAccount (anyOf 2) | null | Alternative | |
isInternational | boolean | Optional | Boolean for whether the employee outside the US |
isManager | boolean | Optional | Boolean for whether the employee is a manager |
isPeoEmployee | boolean | Optional | Boolean for whether the employee is under a PEO |
isRemote | boolean | Optional | If the employee is a remote worker or not |
lastName | string | Optional | Last name of the employee |
level | JSON | Optional | |
level (anyOf 1) | string | Alternative | The level of the employee |
level (anyOf 2) | null | Alternative | |
manager | JSON | Optional | |
manager (anyOf 1) | string | Alternative | The manager of the employee |
manager (anyOf 2) | null | Alternative | |
name | string | Optional | Full name of the employee |
offerAcceptedDate | string | Optional | The date the employee accepted the offer letter |
payScheduleId | string | Optional | The ID of the payschedule |
personalEmail | string | Optional | Personal Email |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone Number |
phone (anyOf 2) | null | Alternative | |
phoneNumber | JSON | Optional | |
phoneNumber (anyOf 1) | string | Alternative | Phone Number |
phoneNumber (anyOf 2) | null | Alternative | |
photo | JSON | Optional | |
photo (anyOf 1) | string | Alternative | |
photo (anyOf 2) | null | Alternative | |
preferredFirstName | string | Optional | |
preferredLastName | string | Optional | |
roleState | string | Optional | The employee's role status - roleState meanings: INIT: An initial record of an individual. An offer has not been made and they have not started working at the company. HIRED: An offer has been made but they have not accepted or started yet. ACCEPTED: An offer has been made and they have accepted, but they have not started yet. ACTIVE: The employee currently works at the company and their start date is today or in the past. TERMINATED: The employee is no longer active. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
smallPhoto | JSON | Optional | |
smallPhoto (anyOf 1) | string | Alternative | |
smallPhoto (anyOf 2) | null | Alternative | |
spokeId | JSON | Optional | |
spokeId (anyOf 1) | string | Alternative | |
spokeId (anyOf 2) | null | Alternative | |
ssn | JSON | Optional | |
ssn (anyOf 1) | string | Alternative | Social Security Number |
ssn (anyOf 2) | null | Alternative | |
startDate | string | Optional | The employee's start date on Rippling. |
teams | array | Optional | The teams the employee is on |
teams[] | JSON | Each item | |
terminationInfo | Model | Optional | Expand GET Employees — employee Api get Employees — response body — termination Info |
title | string | Optional | The employee's work title |
updatedAt | string | Optional | When the row was updated |
userId | JSON | Optional | |
userId (anyOf 1) | string | Alternative | This is the unique user ID of the employee. A userID can span across 1 or many companies. |
userId (anyOf 2) | null | Alternative | |
w2EndDate | JSON | Optional | |
w2EndDate (anyOf 1) | string | Alternative | The employee's end date as a W2 employee. |
w2EndDate (anyOf 2) | null | Alternative | |
w2StartDate | string | Optional | The employee's start date as a W2 employee. |
workEmail | JSON | Optional | |
workEmail (anyOf 1) | string | Alternative | The work email of the employee |
workEmail (anyOf 2) | null | Alternative | |
workLocation | JSON | Optional | |
workLocation (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
workLocation (anyOf 1).city | string | Optional | |
workLocation (anyOf 1).country | string | Optional | |
workLocation (anyOf 1).state | string | Optional | |
workLocation (anyOf 1).streetLine1 | string | Optional | |
workLocation (anyOf 1).zip | string | Optional | |
workLocation (anyOf 2) | null | Alternative | |
workLocationId | string | Optional | The unique identifier of the employee's work location |
workLocationNickname | string | Optional | The nickname for the work location |
workSchedule | Model | Optional | Expand GET Employee — employee Api get Employees Employee Id — response body — work Schedule |
Referenced models: GET Employee — employee Api get Employees Employee Id — response body — company Employment Type, GET Employee — employee Api get Employees Employee Id — response body — work Schedule, GET Custom Fields — response body — item, GET Employees — employee Api get Employees — response body — compensation, GET Employees — employee Api get Employees — response body — termination Info
GET Employee — employee Api get Employees Employee Id — response body — company Employment Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A company employment type model object. |
company | string | Optional | |
country | string | Optional | |
createdAt | string | Optional | |
displayName | string | Optional | |
external_on_changes | JSON | Optional | |
external_on_changes (anyOf 1) | string | Alternative | |
external_on_changes (anyOf 2) | array | Alternative | |
external_on_changes (anyOf 2)[] | JSON | Each item | |
id | string | Optional | |
isContractor | JSON | Optional | |
isContractor (anyOf 1) | boolean | Alternative | |
isContractor (anyOf 2) | null | Alternative | |
isDeleted | boolean | Optional | |
isEOR | string | Optional | |
isFullTime | JSON | Optional | |
isFullTime (anyOf 1) | boolean | Alternative | |
isFullTime (anyOf 2) | null | Alternative | |
isHourly | JSON | Optional | |
isHourly (anyOf 1) | boolean | Alternative | |
isHourly (anyOf 2) | null | Alternative | |
isPartTime | JSON | Optional | |
isPartTime (anyOf 1) | boolean | Alternative | |
isPartTime (anyOf 2) | null | Alternative | |
isSalaried | JSON | Optional | |
isSalaried (anyOf 1) | boolean | Alternative | |
isSalaried (anyOf 2) | null | Alternative | |
isTemporary | JSON | Optional | |
isTemporary (anyOf 1) | boolean | Alternative | |
isTemporary (anyOf 2) | null | Alternative | |
label | string | Optional | |
lock | JSON | Optional | |
lock (anyOf 1) | string | Alternative | |
lock (anyOf 2) | null | Alternative | |
possible_new_employment_types | array | Optional | |
possible_new_employment_types[] | JSON | Each item | |
updatedAt | string | Optional |
GET Employee — employee Api get Employees Employee Id — response body — work Schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The set work schedule for the employee, as designated in their employee profile. |
FRIDAY | object | Optional | |
FRIDAY.hours | string | Optional | |
MONDAY | object | Optional | |
MONDAY.hours | string | Optional | |
SATURDAY | object | Optional | |
SATURDAY.hours | string | Optional | |
SUNDAY | object | Optional | |
SUNDAY.hours | string | Optional | |
THURSDAY | object | Optional | |
THURSDAY.hours | string | Optional | |
TUESDAY | object | Optional | |
TUESDAY.hours | string | Optional | |
WEDNESDAY | object | Optional | |
WEDNESDAY.hours | string | Optional |
GET Employees — employee Api get Employees — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An employee model object. |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
address (anyOf 1).city | string | Optional | |
address (anyOf 1).country | string | Optional | |
address (anyOf 1).state | string | Optional | |
address (anyOf 1).streetLine1 | string | Optional | |
address (anyOf 1).zip | string | Optional | |
address (anyOf 2) | null | Alternative | |
companyEmploymentType | Model | Optional | Expand GET Employees — employee Api get Employees — response body — company Employment Type |
compensation | Model | Optional | Expand GET Employees — employee Api get Employees — response body — compensation |
createdAt | string | Optional | When the row was created |
customFields | Model | Optional | Expand GET Custom Fields — response body — item |
department | string | Optional | The employee's department name |
departmentId | string | Optional | The unique identifier of the employee's department |
dob | string | Optional | Date of birth |
ein | string | Optional | The employee identifier number |
employeeNumber | JSON | Optional | |
employeeNumber (anyOf 1) | string | Alternative | The employee number |
employeeNumber (anyOf 2) | JSON | Alternative | |
employeeNumber (anyOf 2) (anyOf 1) | integer | Alternative | |
employeeNumber (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
employmentType | string | Optional | An ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured. Known values: CONTRACTOR, SALARIED_FT, SALARIED_PT, HOURLY_FT, HOURLY_PT, TEMP |
endDate | JSON | Optional | |
endDate (anyOf 1) | string | Alternative | The employee's end date. Will only return information after the employee's termination. |
endDate (anyOf 2) | null | Alternative | |
entityId | string | Optional | The legal entity ID the employee is employed on |
filingStatus | JSON | Optional | |
filingStatus (anyOf 1) | string | Alternative | An ENUM of Filing Status Known values: SINGLE, MARRIED, MARRIED_USER_SINGLE_RATE |
filingStatus (anyOf 2) | null | Alternative | |
firstName | string | Optional | First name of the employee |
flsaStatus | string | Optional | The employee's FLSA status stating whether they are exempt or non-exempt Known values: exempt, non-exempt |
gender | JSON | Optional | |
gender (anyOf 1) | string | Alternative | The employee's gender Known values: MALE, FEMALE |
gender (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1) | object | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).annualLimit | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).annualLimit (anyOf 1) | string | Alternative | Known values: INDIVIDUAL, FAMILY, NULL |
hsaCompatiblePlanStatus (anyOf 1).annualLimit (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 1) | string | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).effectiveDate (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate | JSON | Optional | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 1) | string | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).expirationDate (anyOf 2) | null | Alternative | |
hsaCompatiblePlanStatus (anyOf 1).status | string | Optional | Known values: ENROLLED, NOT_ENROLLED, NOT_OFFERED, PENDING_ENROLLMENT |
hsaCompatiblePlanStatus (anyOf 2) | null | Alternative | |
id | string | Optional | This is the unique role ID of the employee. A role ID exists per 1 and only 1 company. |
identifiedGender | JSON | Optional | |
identifiedGender (anyOf 1) | string | Alternative | The employee's identified gender |
identifiedGender (anyOf 2) | null | Alternative | |
internationalBankAccount | JSON | Optional | |
internationalBankAccount (anyOf 1) | string | Alternative | The international bank account |
internationalBankAccount (anyOf 2) | null | Alternative | |
isInternational | boolean | Optional | Boolean for whether the employee outside the US |
isManager | boolean | Optional | Boolean for whether the employee is a manager |
isPeoEmployee | boolean | Optional | Boolean for whether the employee is under a PEO |
isRemote | boolean | Optional | If the employee is a remote worker or not |
lastName | string | Optional | Last name of the employee |
level | JSON | Optional | |
level (anyOf 1) | string | Alternative | The level of the employee |
level (anyOf 2) | null | Alternative | |
manager | JSON | Optional | |
manager (anyOf 1) | string | Alternative | The manager of the employee |
manager (anyOf 2) | null | Alternative | |
name | string | Optional | Full name of the employee |
offerAcceptedDate | string | Optional | The date the employee accepted the offer letter |
payScheduleId | string | Optional | The ID of the payschedule |
personalEmail | string | Optional | Personal Email |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone Number |
phone (anyOf 2) | null | Alternative | |
phoneNumber | JSON | Optional | |
phoneNumber (anyOf 1) | string | Alternative | Phone Number |
phoneNumber (anyOf 2) | null | Alternative | |
photo | JSON | Optional | |
photo (anyOf 1) | string | Alternative | |
photo (anyOf 2) | null | Alternative | |
preferredFirstName | string | Optional | |
preferredLastName | string | Optional | |
roleState | string | Optional | The employee's role status - roleState meanings: INIT: An initial record of an individual. An offer has not been made and they have not started working at the company. HIRED: An offer has been made but they have not accepted or started yet. ACCEPTED: An offer has been made and they have accepted, but they have not started yet. ACTIVE: The employee currently works at the company and their start date is today or in the past. TERMINATED: The employee is no longer active. Known values: INIT, HIRED, ACCEPTED, ACTIVE, TERMINATED |
smallPhoto | JSON | Optional | |
smallPhoto (anyOf 1) | string | Alternative | |
smallPhoto (anyOf 2) | null | Alternative | |
spokeId | JSON | Optional | |
spokeId (anyOf 1) | string | Alternative | |
spokeId (anyOf 2) | null | Alternative | |
ssn | JSON | Optional | |
ssn (anyOf 1) | string | Alternative | Social Security Number |
ssn (anyOf 2) | null | Alternative | |
startDate | string | Optional | The employee's start date on Rippling. |
teams | array | Optional | The teams the employee is on |
teams[] | JSON | Each item | |
terminationInfo | Model | Optional | Expand GET Employees — employee Api get Employees — response body — termination Info |
title | string | Optional | The employee's work title |
updatedAt | string | Optional | When the row was updated |
userId | JSON | Optional | |
userId (anyOf 1) | string | Alternative | This is the unique user ID of the employee. A userID can span across 1 or many companies. |
userId (anyOf 2) | null | Alternative | |
w2EndDate | JSON | Optional | |
w2EndDate (anyOf 1) | string | Alternative | The employee's end date as a W2 employee. |
w2EndDate (anyOf 2) | null | Alternative | |
w2StartDate | string | Optional | The employee's start date as a W2 employee. |
workEmail | JSON | Optional | |
workEmail (anyOf 1) | string | Alternative | The work email of the employee |
workEmail (anyOf 2) | null | Alternative | |
workLocation | JSON | Optional | |
workLocation (anyOf 1) | object | Alternative | An address object as stored within Rippling. |
workLocation (anyOf 1).city | string | Optional | |
workLocation (anyOf 1).country | string | Optional | |
workLocation (anyOf 1).state | string | Optional | |
workLocation (anyOf 1).streetLine1 | string | Optional | |
workLocation (anyOf 1).zip | string | Optional | |
workLocation (anyOf 2) | null | Alternative | |
workLocationId | string | Optional | The unique identifier of the employee's work location |
workLocationNickname | string | Optional | The nickname for the work location |
workSchedule | Model | Optional | Expand GET Employees — employee Api get Employees — response body — work Schedule |
Referenced models: GET Employees — employee Api get Employees — response body — company Employment Type, GET Custom Fields — response body — item, GET Employees — employee Api get Employees — response body — compensation, GET Employees — employee Api get Employees — response body — termination Info, GET Employees — employee Api get Employees — response body — work Schedule
GET Employees — employee Api get Employees — response body — company Employment Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A company employment type model object. |
company | string | Optional | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
createdAt | string | Optional | |
displayName | string | Optional | |
external_on_changes | JSON | Optional | |
external_on_changes (anyOf 1) | string | Alternative | |
external_on_changes (anyOf 2) | array | Alternative | |
external_on_changes (anyOf 2)[] | JSON | Each item | |
id | string | Optional | |
isContractor | JSON | Optional | |
isContractor (anyOf 1) | boolean | Alternative | |
isContractor (anyOf 2) | null | Alternative | |
isDeleted | boolean | Optional | |
isEOR | JSON | Optional | |
isEOR (anyOf 1) | string | Alternative | |
isEOR (anyOf 2) | null | Alternative | |
isFullTime | JSON | Optional | |
isFullTime (anyOf 1) | boolean | Alternative | |
isFullTime (anyOf 2) | null | Alternative | |
isHourly | JSON | Optional | |
isHourly (anyOf 1) | boolean | Alternative | |
isHourly (anyOf 2) | null | Alternative | |
isPartTime | JSON | Optional | |
isPartTime (anyOf 1) | boolean | Alternative | |
isPartTime (anyOf 2) | null | Alternative | |
isSalaried | JSON | Optional | |
isSalaried (anyOf 1) | boolean | Alternative | |
isSalaried (anyOf 2) | null | Alternative | |
isTemporary | JSON | Optional | |
isTemporary (anyOf 1) | boolean | Alternative | |
isTemporary (anyOf 2) | null | Alternative | |
label | string | Optional | |
lock | JSON | Optional | |
lock (anyOf 1) | string | Alternative | |
lock (anyOf 2) | null | Alternative | |
possible_new_employment_types | array | Optional | |
possible_new_employment_types[] | JSON | Each item | |
updatedAt | string | Optional |
GET Employees — employee Api get Employees — response body — compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A compensation package model object. |
annualSalary | string | Optional | |
bonusPaymentDays | JSON | Optional | |
bonusPaymentDays (anyOf 1) | string | Alternative | |
bonusPaymentDays (anyOf 2) | null | Alternative | |
bonusSchedule | string | Optional | |
currency | string | Optional | |
equityNumShares | JSON | Optional | |
equityNumShares (anyOf 1) | integer | Alternative | |
equityNumShares (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
onTargetCommission | string | Optional | |
relocationReimbursement | string | Optional | |
salaryPerUnit | string | Optional | |
salaryUnit | JSON | Optional | Known values: HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD |
signingBonus | string | Optional | |
targetAnnualBonus | string | Optional | |
targetAnnualBonusPercent | string | Optional |
GET Employees — employee Api get Employees — response body — termination Info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A terminationInfo object within Rippling. |
terminationReason | string | Optional | This is a description that will be custom to each Rippling company. |
terminationType | JSON | Optional | The termination type indicates whether the termination was voluntary or involuntary. Known values: VOLUNTARY, INVOLUNTARY |
GET Employees — employee Api get Employees — response body — work Schedule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The set work schedule for the employee, as designated in their employee profile. |
FRIDAY | object | Optional | |
FRIDAY.hours | string | Optional | |
MONDAY | object | Optional | |
MONDAY.hours | string | Optional | |
SATURDAY | object | Optional | |
SATURDAY.hours | JSON | Optional | |
SATURDAY.hours (anyOf 1) | string | Alternative | |
SATURDAY.hours (anyOf 2) | JSON | Alternative | |
SATURDAY.hours (anyOf 2) (anyOf 1) | number | Alternative | |
SATURDAY.hours (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
SUNDAY | object | Optional | |
SUNDAY.hours | JSON | Optional | |
SUNDAY.hours (anyOf 1) | string | Alternative | |
SUNDAY.hours (anyOf 2) | JSON | Alternative | |
SUNDAY.hours (anyOf 2) (anyOf 1) | number | Alternative | |
SUNDAY.hours (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
THURSDAY | object | Optional | |
THURSDAY.hours | string | Optional | |
TUESDAY | object | Optional | |
TUESDAY.hours | string | Optional | |
WEDNESDAY | object | Optional | |
WEDNESDAY.hours | string | Optional |