Schema Information of when I Work
Schema Information of when I Work
Tables/APIs
| List of Tables/APIs |
|---|
List Times |
List Users |
Position |
Locations |
List Shift |
List Payroll |
List Times
Purpose: Retrieve a list of all shifts
Source API Documentation: https://apidocs.wheniwork.com/external/index.html#tag/Times
Replication: Key-Based Replication
Replication Key: LastRunTime
Fields
fullname |
type |
|---|---|
id |
NUMERIC |
account_id |
NUMERIC |
user_id |
NUMERIC |
creator_id |
NUMERIC |
position_id |
NUMERIC |
location_id |
NUMERIC |
site_id |
NUMERIC |
shift_id |
NUMERIC |
start_time |
TIMESTAMP |
end_time |
TIMESTAMP |
notes |
STRING |
length |
NUMERIC |
hourly_rate |
NUMERIC |
alert_type |
NUMERIC |
is_approved |
BOOLEAN |
modified_by |
NUMERIC |
sync_id |
STRING |
sync_hash |
STRING |
updated_at |
TIMESTAMP |
created_at |
TIMESTAMP |
break_hours |
NUMERIC |
is_alerted |
BOOLEAN |
_daton_user_id |
NUMERIC |
_daton_batch_runtime |
NUMERIC |
_daton_batch_id |
NUMERIC |
Locations
Purpose: Retrieves all the schedule in a account
Source API Documentation: https://apidocs.wheniwork.com/external/index.html#tag/Schedules-(Locations)/paths/~12~1locations/get
Replication: Key-Based Replication
Replication Key: NA
Fields
fullname |
type |
|---|---|
id |
NUMERIC |
account_id |
NUMERIC |
is_default |
NUMERIC |
name |
STRING |
sort |
NUMERIC |
max_hours |
NUMERIC |
address |
STRING |
latitude |
NUMERIC |
longitude |
NUMERIC |
place_id |
NUMERIC |
place_confirmed |
BOOLEAN |
ip_address |
STRING |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
is_deleted |
BOOLEAN |
deleted_at |
STRING |
updated_by |
STRING |
coordinates |
STRING |
radius |
NUMERIC |
place |
RECORD |
_daton_user_id |
NUMERIC |
_daton_batch_runtime |
NUMERIC |
_daton_batch_id |
NUMERIC |
place.id |
NUMERIC |
place.business_name |
STRING |
place.address |
STRING |
place.street_name |
STRING |
place.street_number |
STRING |
place.locality |
STRING |
place.sub_locality |
STRING |
place.region |
STRING |
place.postal_code |
STRING |
place.country |
STRING |
place.latitude |
NUMERIC |
place.longitude |
NUMERIC |
place.place_type |
STRING |
place.place_id |
STRING |
place.updated_at |
TIMESTAMP |
place.updated_by |
STRING |
place.formatted_phone_number |
STRING |
place.international_phone_number |
STRING |
place.website |
STRING |
List Users
Purpose: Fetches all the users
Source API Documentation: https://apidocs.wheniwork.com/external/index.html#tag/Users
Replication: Key-Based Replication
Replication Key: LastRunTime
Fields
fullname |
type |
|---|---|
id |
NUMERIC |
account_id |
NUMERIC |
login_id |
NUMERIC |
timezone_id |
NUMERIC |
created_by |
NUMERIC |
role |
NUMERIC |
is_payroll |
BOOLEAN |
is_trusted |
NUMERIC |
type |
NUMERIC |
email |
STRING |
first_name |
STRING |
last_name |
STRING |
phone_number |
STRING |
employee_code |
STRING |
activated |
BOOLEAN |
is_hidden |
BOOLEAN |
uuid |
STRING |
notes |
STRING |
is_private |
BOOLEAN |
hours_preferred |
NUMERIC |
hours_max |
NUMERIC |
hourly_rate |
NUMERIC |
alert_settings |
RECORD |
reminder_time |
NUMERIC |
sleep_start |
TIME |
sleep_end |
TIME |
is_onboarded |
BOOLEAN |
last_login |
STRING |
terminated_at |
STRING |
notified_at |
STRING |
invited_at |
TIMESTAMP |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
deleted_at |
STRING |
is_deleted |
BOOLEAN |
delete_reason |
STRING |
avatar_key |
STRING |
employment_type |
STRING |
middle_name |
STRING |
start_date |
STRING |
is_active |
BOOLEAN |
password |
BOOLEAN |
country_id |
NUMERIC |
c2dm_auth_key |
NUMERIC |
migration_id |
NUMERIC |
affiliate |
NUMERIC |
infotips |
STRING |
timezone_name |
STRING |
avatar |
RECORD |
positions |
STRING |
locations |
STRING |
position_rates |
RECORD |
position_quality |
RECORD |
sort |
RECORD |
deletion_queued |
BOOLEAN |
_daton_user_id |
NUMERIC |
_daton_batch_runtime |
NUMERIC |
_daton_batch_id |
NUMERIC |
dismissed_at |
TIMESTAMP |
country_code |
STRING |
is_internal_login |
BOOLEAN |
alert_settings.timeoff |
RECORD |
alert_settings.timeoff.sms |
BOOLEAN |
alert_settings.timeoff.email |
BOOLEAN |
alert_settings.swaps |
RECORD |
alert_settings.swaps.sms |
BOOLEAN |
alert_settings.swaps.email |
BOOLEAN |
alert_settings.schedule |
RECORD |
alert_settings.schedule.sms |
BOOLEAN |
alert_settings.schedule.email |
BOOLEAN |
alert_settings.reminders |
RECORD |
alert_settings.reminders.sms |
BOOLEAN |
alert_settings.reminders.email |
BOOLEAN |
alert_settings.availability |
RECORD |
alert_settings.availability.sms |
BOOLEAN |
alert_settings.availability.email |
BOOLEAN |
alert_settings.new_employee |
RECORD |
alert_settings.new_employee.sms |
BOOLEAN |
alert_settings.new_employee.email |
BOOLEAN |
alert_settings.attendance |
RECORD |
alert_settings.attendance.sms |
BOOLEAN |
alert_settings.attendance.email |
BOOLEAN |
alert_settings.payroll |
RECORD |
alert_settings.payroll.sms |
BOOLEAN |
alert_settings.payroll.email |
BOOLEAN |
alert_settings.hire |
RECORD |
alert_settings.hire.sms |
BOOLEAN |
alert_settings.hire.email |
BOOLEAN |
alert_settings.workchat |
RECORD |
alert_settings.workchat.alerts |
BOOLEAN |
alert_settings.workchat.badge_icon |
BOOLEAN |
alert_settings.workchat.in_app |
BOOLEAN |
alert_settings.reporting |
RECORD |
alert_settings.reporting.sms |
BOOLEAN |
alert_settings.reporting.email |
BOOLEAN |
alert_settings.shift_bidding |
RECORD |
alert_settings.shift_bidding.sms |
BOOLEAN |
alert_settings.shift_bidding.email |
BOOLEAN |
alert_settings.workplace_alerts |
RECORD |
alert_settings.workplace_alerts.sms |
BOOLEAN |
alert_settings.workplace_alerts.email |
BOOLEAN |
alert_settings.absences |
RECORD |
alert_settings.absences.sms |
BOOLEAN |
alert_settings.absences.email |
BOOLEAN |
alert_settings.ot_alerts |
RECORD |
alert_settings.ot_alerts.sms |
BOOLEAN |
alert_settings.ot_alerts.email |
BOOLEAN |
alert_settings.shift-bidding |
RECORD |
alert_settings.shift-bidding.sms |
BOOLEAN |
alert_settings.shift-bidding.email |
BOOLEAN |
avatar.url |
STRING |
avatar.size |
STRING |
position_rates._385109 |
NUMERIC |
position_rates._0052128 |
NUMERIC |
position_rates._0507330 |
NUMERIC |
position_rates._0507331 |
NUMERIC |
position_rates._0507332 |
NUMERIC |
position_rates._0507333 |
NUMERIC |
position_rates._0507334 |
NUMERIC |
position_rates._0507335 |
NUMERIC |
position_rates._0646340 |
NUMERIC |
position_rates._1038147 |
NUMERIC |
position_rates._1038148 |
NUMERIC |
position_rates._daton_pre_2385109 |
NUMERIC |
position_rates._daton_pre_10052128 |
NUMERIC |
position_rates._daton_pre_10507330 |
NUMERIC |
position_rates._daton_pre_10507331 |
NUMERIC |
position_rates._daton_pre_10507332 |
NUMERIC |
position_rates._daton_pre_10507333 |
NUMERIC |
position_rates._daton_pre_10507334 |
NUMERIC |
position_rates._daton_pre_10507335 |
NUMERIC |
position_rates._daton_pre_10646340 |
NUMERIC |
position_rates._daton_pre_11038147 |
NUMERIC |
position_rates._daton_pre_11038148 |
NUMERIC |
position_rates._daton_pre_2383816 |
NUMERIC |
position_rates._daton_pre_11008917 |
NUMERIC |
position_rates._daton_pre_2382484 |
NUMERIC |
position_rates._daton_pre_2383795 |
NUMERIC |
position_rates._daton_pre_10262243 |
NUMERIC |
position_quality._385109 |
NUMERIC |
position_quality._0052128 |
NUMERIC |
position_quality._0507330 |
NUMERIC |
position_quality._0507331 |
NUMERIC |
position_quality._0507332 |
NUMERIC |
position_quality._0507333 |
NUMERIC |
position_quality._0507334 |
NUMERIC |
position_quality._0507335 |
NUMERIC |
position_quality._0646340 |
NUMERIC |
position_quality._1038147 |
NUMERIC |
position_quality._1038148 |
NUMERIC |
position_quality._daton_pre_2385109 |
NUMERIC |
position_quality._daton_pre_10052128 |
NUMERIC |
position_quality._daton_pre_10507330 |
NUMERIC |
position_quality._daton_pre_10507331 |
NUMERIC |
position_quality._daton_pre_10507332 |
NUMERIC |
position_quality._daton_pre_10507333 |
NUMERIC |
position_quality._daton_pre_10507334 |
NUMERIC |
position_quality._daton_pre_10507335 |
NUMERIC |
position_quality._daton_pre_10646340 |
NUMERIC |
position_quality._daton_pre_11038147 |
NUMERIC |
position_quality._daton_pre_11038148 |
NUMERIC |
position_quality._daton_pre_2383816 |
NUMERIC |
position_quality._daton_pre_11008917 |
NUMERIC |
position_quality._daton_pre_2382484 |
NUMERIC |
position_quality._daton_pre_2383795 |
NUMERIC |
position_quality._daton_pre_10262243 |
NUMERIC |
sort._179391 |
NUMERIC |
sort._232098 |
NUMERIC |
sort._daton_pre_1179391 |
NUMERIC |
sort._daton_pre_1232098 |
NUMERIC |
sort._daton_pre_1180252 |
NUMERIC |
List Shifts
Purpose: Returns list of all shifts
Source API Documentation: https://apidocs.wheniwork.com/external/index.html#tag/Shifts/paths/~12~1shifts/get
Replication: Key-Based Replication
Replication Key: LastRunTime
Fields
fullname |
type |
|---|---|
id |
NUMERIC |
account_id |
NUMERIC |
user_id |
NUMERIC |
location_id |
NUMERIC |
position_id |
NUMERIC |
site_id |
NUMERIC |
start_time |
TIMESTAMP |
end_time |
TIMESTAMP |
break_time |
NUMERIC |
color |
STRING |
notes |
STRING |
alerted |
BOOLEAN |
shiftchain_key |
STRING |
published |
BOOLEAN |
published_date |
TIMESTAMP |
notified_at |
TIMESTAMP |
instances |
NUMERIC |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
acknowledged |
NUMERIC |
acknowledged_at |
TIMESTAMP |
creator_id |
NUMERIC |
is_open |
BOOLEAN |
actionable |
BOOLEAN |
block_id |
NUMERIC |
requires_openshift_approval |
BOOLEAN |
openshift_approval_request_id |
NUMERIC |
is_trimmed |
BOOLEAN |
is_approved_without_time |
BOOLEAN |
_daton_user_id |
NUMERIC |
_daton_batch_runtime |
NUMERIC |
_daton_batch_id |
NUMERIC |
Positions
Purpose: Retrieves all the positions
Source API Documentation: https://apidocs.wheniwork.com/external/index.html#tag/Positions/paths/~12~1positions/get
Replication: Key-Based Replication
Replication Key: NA
Fields
fullname |
type |
|---|---|
id |
NUMERIC |
account_id |
NUMERIC |
name |
STRING |
color |
STRING |
sort |
NUMERIC |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
is_deleted |
BOOLEAN |
updated_by |
STRING |
tips_tracking |
NUMERIC |
_daton_user_id |
NUMERIC |
_daton_batch_runtime |
NUMERIC |
_daton_batch_id |
NUMERIC |
List Payroll
Purpose: Retrieves listing of payroll periods
Source API Documentation: https://apidocs.wheniwork.com/external/index.html#tag/Payrolls/paths/~12~1payrolls/get
Replication: Key-Based Replication
Replication Key: LastRunTime
Fields
fullname |
type |
|---|---|
id |
NUMERIC |
account_id |
NUMERIC |
creator_id |
NUMERIC |
start_date |
TIMESTAMP |
end_date |
TIMESTAMP |
settings |
RECORD |
offset |
TIME |
notes |
STRING |
is_edited |
NUMERIC |
is_closed |
BOOLEAN |
closed_at |
DATETIME |
is_finalized |
BOOLEAN |
finalized_at |
TIMESTAMP |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
updated_by |
STRING |
_daton_user_id |
NUMERIC |
_daton_batch_runtime |
NUMERIC |
_daton_batch_id |
NUMERIC |
user_id |
NUMERIC |
position_id |
NUMERIC |
location_id |
NUMERIC |
site_id |
NUMERIC |
shift_id |
NUMERIC |
start_time |
TIMESTAMP |
end_time |
TIMESTAMP |
length |
NUMERIC |
hourly_rate |
NUMERIC |
alert_type |
NUMERIC |
is_approved |
BOOLEAN |
modified_by |
NUMERIC |
sync_id |
STRING |
sync_hash |
STRING |
break_hours` |
NUMERIC |
is_alerted |
BOOLEAN |
settings.enabled |
BOOLEAN |
settings.timesheets |
BOOLEAN |
settings.type |
NUMERIC |
settings.hours_max |
NUMERIC |
settings.hours_max_enabled |
BOOLEAN |
settings.hours_max_daily |
NUMERIC |
settings.hours_max_daily_enabled |
BOOLEAN |
settings.hours_dot_daily |
NUMERIC |
settings.hours_dot_daily_enabled |
BOOLEAN |
settings.ot_multiplier |
NUMERIC |
settings.dbl_multiplier |
NUMERIC |
settings.work_day_start |
TIME |
settings.adp_enabled |
BOOLEAN |
settings.adp_viewable |
BOOLEAN |
settings.is_onboarded |
BOOLEAN |
settings.ot_alerts_clockin |
BOOLEAN |
settings.ot_alerts_clockout |
BOOLEAN |
settings.ot_alerts_within |
NUMERIC |
settings.reveal_attendance |
BOOLEAN |
settings.use_sow_for_ot |
BOOLEAN |
settings.max_enforcement |
RECORD |
settings.max_enforcement.enabled |
BOOLEAN |
settings.rounding |
RECORD |
settings.rounding.enabled |
BOOLEAN |
settings.rounding.minuteIncrement |
NUMERIC |
settings.tips_tracking |
BOOLEAN |
settings.ot_prevention |
RECORD |
settings.ot_prevention.enabled |
BOOLEAN |
settings.ot_prevention.prevent_all |
BOOLEAN |
settings.ot_prevention.allow_up_to |
NUMERIC |