Skip to main content
Deputy logo
  • Category: human resources
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 247
  • Triggers: 0
  • Slug: DEPUTY
  • Version: 20261101_00

Tools

Slug: DEPUTY_ADD_RESOURCE_COMMENTAdd comment text to one Deputy resource record.

Input Parameters

string
required
Comment text to add to the record.
integer
required
Numeric Deputy resource record ID.
string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_APPLY_TIMESHEET_OPERATIONApply a non-clock timesheet operation: update for self or supervised timesheets, dispute or IP amend for self, and approve or discard for supervised timesheets. Use the dedicated supervised timesheet actions for clock start, end, and pause.

Input Parameters

object
required
Request object documented by Deputy for the selected non-clock timesheet operation.
string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
string ("update" | "dispute" | "ipamend" | "approve" | "discard")
required
Timesheet operation to apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_BULK_UPSERT_RESOURCE_RECORDSCreate or update multiple records of one resource type. Deputy processes each record independently, so inspect every item result for partial failures.

Input Parameters

array
required
Typed records to create or update. All must match resource_type.
string ("employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type shared by every record in the batch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_COPY_COMPANY_ROSTER_TEMPLATECreate a roster-template copy for a Deputy company from the supplied template data.

Input Parameters

object
required
Provider request object for this operation.
string
required
Deputy company ID whose roster templates to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_CREATE_EMPLOYEE_LEAVECreate a new employee leave record. Deputy requires the employee, status, start and end dates, approval comment, and overlapping-roster action on every request; this route does not update an existing leave ID.

Input Parameters

integer ("1" | "2")
required
Creation action: 1 creates approved leave; 2 creates declined leave. Deputy rejects 0 and 3 on this create route.
string
required
End date of the employee leave in YYYY-MM-DD format.
string
required
Start date of the employee leave in YYYY-MM-DD format.
integer
required
Numeric Deputy employee ID for the leave record.
string
required
Comment regarding approval or disposition of the leave.
integer
required
Deputy action code controlling how overlapping rosters are handled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_CREATE_EMPLOYEE_UNAVAILABILITYCreate a recurring unavailability record for a specific supervised employee. Deputy must confirm the same employee in its response; a mismatched or unverifiable 2xx response is rejected.

Input Parameters

string
required
Comment explaining the employee’s unavailability.
integer
required
Numeric Deputy employee ID for the unavailability record.
integer
required
End of the unavailability as a Unix timestamp.
string
required
Recurrence day code, such as MO for Monday.
integer
required
Start of the unavailability as a Unix timestamp.
integer
required
Number of recurrence-frequency units between occurrences.
string
required
Recurrence frequency, such as WEEKLY.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_CREATE_OR_REPLACE_RESOURCE_RECORDCreate a resource record, or fully replace the matching record when the supplied data identifies one. Verify identifiers and the complete replacement fields before running.

Input Parameters

string
required
Typed Deputy record to create or replace. resource_type selects the matching endpoint and schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_CREATE_RESOURCE_RECORDCreate an Employee, Leave, OperationalUnit, Roster, or Timesheet record from typed agent-facing fields.

Input Parameters

string
required
Typed Deputy record to create. resource_type selects the matching endpoint and schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DECLINE_GAMINGFY_ITEMDecline the Gamingfy item identified by the supplied request object, changing its state.

Input Parameters

object
required
Provider request object for this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_MY_MEMO_BY_ID_COMMENT_BY_COMMENT_IDDelete a comment from the specified memo. Verify the memo and comment IDs before deleting it.

Input Parameters

integer
required
Numeric Deputy memo ID containing the comment.
integer
required
Numeric Deputy memo comment ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_MY_PREF_BY_PREF_KEYDelete one preference for the connected Deputy user by preference key. Verify the key before deleting it.

Input Parameters

string
required
Preference key to delete for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_MY_TODO_BY_TODO_IDDelete a to-do item belonging to the connected user by its numeric ID. Verify the ID before deleting it.

Input Parameters

integer
required
Numeric Deputy to-do item ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_MY_TOKEN_BY_STR_ID_OR_TOKENInvalidate the Deputy token identified by its documented token ID or token value. Verify the target before deleting it.

Input Parameters

string
required
Documented Deputy token ID or token value to invalidate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_RESOURCE_COMMENTPermanently delete one comment from a Deputy resource record. Verify both IDs first.

Input Parameters

integer
required
Numeric Deputy resource record ID.
integer
required
Numeric ID of the comment to delete.
string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_RESOURCE_RECORDPermanently delete an Employee, Leave, OperationalUnit, Roster, or Timesheet record by ID. Verify the resource type and record ID first.

Input Parameters

integer
required
Numeric Deputy resource record ID.
string ("employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_SUPERVISE_DEPARTMENT_BY_IDPermanently delete the Deputy department identified by department ID.

Input Parameters

integer
required
Documented Deputy path parameter id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATE_BY_TEMPLATE_IDPermanently delete an employee contracted-hours template by template ID.

Input Parameters

integer
required
Documented Deputy path parameter templateId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_SUPERVISE_EMPLOYEE_INVITATIONDelete the employee invitation data selected by Deputy’s zero-input invitation endpoint; deletion is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_SUPERVISE_ROSTER_TEMPLATE_BY_TEMPLATE_IDPermanently delete a Deputy roster template by template ID.

Input Parameters

integer
required
Documented Deputy path parameter templateId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_DELETE_UNAVAILABILITYPermanently delete a self or supervised employee unavailability record by ID.

Input Parameters

string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
integer
required
Numeric Deputy unavailability record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_FIND_MATCHING_RESOURCE_RECORDFind the closest existing record matching a partial typed record before deciding whether to create or update it.

Input Parameters

string
required
Partial typed Deputy record used to find the closest existing match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_CURRENT_USERReturn the connected Deputy user’s workplaces, departments, role, permissions, and setup capabilities without contact or address details. This does not return OAuth identity; use GET_ME for that.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_DEPARTMENT_WEATHERGet current weather or weather for a specified date for one Deputy department.

Input Parameters

string
Optional date in YYYY-M-D or YYYY-MM-DD format. Omit for current weather.
integer
required
Numeric Deputy department ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_LOCATION_WEATHERGet current weather or weather for a specified date for locations in one Deputy company.

Input Parameters

string
Optional date in YYYY-M-D or YYYY-MM-DD format. Omit for current weather.
integer
required
Numeric Deputy company ID whose location weather to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MEGet OAuth Identity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_COLLEAGUEList colleagues visible to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_COLLEAGUE_COUNTReturn the number of colleagues visible to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_CONTACTADDRESSList contact addresses available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_CONTACTADDRESS_ALLList all contact addresses available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_CONTACTADDRESS_EMERGENCYGet emergency contact addresses for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_CONTACTADDRESS_SUBORDINATEGet contact addresses for employees subordinate to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_CONTACTADDRESS_SUBORDINATE_BY_INT_COMPANY_IDGet subordinate contact addresses for the specified Deputy company.

Input Parameters

integer
required
Deputy company ID whose subordinate contact addresses should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_DEPARTMENT_BY_INT_DEPT_IDGet a Deputy department by its department ID.

Input Parameters

string
required
Deputy department ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_FEED_RANGE_BY_START_TO_BY_ENDGet feed records for the connected Deputy user over the supplied start-to-end interval.

Input Parameters

string
required
Documented Deputy path parameter end.
string
required
Documented Deputy path parameter start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_FEED_SINGLE_BY_DATEGet feed records for the connected Deputy user on the specified date.

Input Parameters

string
required
Documented Deputy path parameter date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_FEED_SUMMARY_BY_START_TO_BY_ENDGet a summary of the connected Deputy user’s feed over the supplied start-to-end interval.

Input Parameters

string
required
Documented Deputy path parameter end.
string
required
Documented Deputy path parameter start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_LEAVE_BY_STR_SETUPGet leave setup data for the connected Deputy user.

Input Parameters

string
required
Deputy leave setup selector used to choose the leave data returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_LOCATION_ALLList all locations available to the connected Deputy account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_LOCATION_BY_INT_COMPANY_IDGet location records for the specified Deputy company.

Input Parameters

string
required
Deputy company ID whose locations should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_LOCATION_BY_INT_COMPANY_ID_ALLOWED_KIOSK_AUTH_MODESList the kiosk authentication modes allowed for locations in the specified Deputy company.

Input Parameters

integer
required
Deputy company ID whose allowed kiosk authentication modes should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_LOCATION_GEO_BY_LATITUDE_BY_LONGITUDEGet Deputy location data for the specified latitude and longitude.

Input Parameters

string
required
Documented Deputy path parameter latitude.
string
required
Documented Deputy path parameter longitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_LOCATION_GEO_BY_LATITUDE_BY_LONGITUDE_FLAG_BY_FLAGGet Deputy location data for the supplied coordinates using the specified location lookup flag.

Input Parameters

string
required
Documented Deputy path parameter latitude.
string
required
Documented Deputy path parameter longitude.
string
required
Deputy location lookup flag that controls the coordinate result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMOList memos available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_BY_IDGet a Deputy memo by its memo ID.

Input Parameters

integer
required
Numeric Deputy memo ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_COMPANY_BY_IDGet memos for a Deputy company by company ID.

Input Parameters

string
required
Deputy company ID whose memos should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_REACTIONS_BY_ORM_BY_REC_IDGet reactions for the specified Deputy record type and record ID.

Input Parameters

string
required
Deputy record ID whose memo reactions should be returned.
string
required
Deputy record type whose memo reactions should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_READList memos marked as read for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_SUMMARYGet memo summary data for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_TEAM_BY_IDGet memos for a Deputy team by team ID.

Input Parameters

string
required
Deputy team ID whose memos should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_UNREADList unread memos for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_MEMO_USER_BY_IDGet memos for a Deputy user by user ID.

Input Parameters

string
required
Deputy user ID whose memos should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_NOTIFICATIONList notifications visible to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_NPS_CANNPSReturn whether the connected Deputy user can submit an NPS response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_PHOTOGet the connected Deputy user’s photo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_PREF_BY_PREF_KEYGet one preference for the connected Deputy user by its preference key.

Input Parameters

string
required
Preference key to retrieve for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_BIDSList roster bids available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_BY_IDGet one roster record available to the connected Deputy user by roster ID.

Input Parameters

integer
required
Numeric Deputy roster ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_BY_ID_OFFER_GETRECOMMENDATIONGet the offer recommendation for a roster by roster ID.

Input Parameters

integer
required
Numeric Deputy roster ID whose offer recommendation should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_BY_ID_OFFER_STATUSGet the offer status for a roster by roster ID.

Input Parameters

integer
required
Numeric Deputy roster ID whose offer status should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_BY_START_DATE_BY_END_DATEGet the connected user’s roster records between the specified start and end dates.

Input Parameters

string
required
Documented Deputy path parameter endDate.
string
required
Documented Deputy path parameter startDate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_OPENList open roster records available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_OPEN_BY_START_DATE_BY_END_DATE_BY_MAX_WAIT_TIMEGet open roster data between the supplied dates, waiting up to the specified maximum wait time.

Input Parameters

string
required
Documented Deputy path parameter endDate.
string
required
Documented Deputy path parameter startDate.
string
required
Documented Deputy path parameter maxWaitTime.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_PUBLISH_ALLOW_BY_NUM_OF_ROSTERS_TO_PUBLISHReturn whether the connected user may publish the specified number of rosters.

Input Parameters

string
required
Documented Deputy path parameter numOfRostersToPublish.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_PUBLISH_COUNTReturn the publish-related roster count for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_ROSTER_START_TIMESTAMP_BY_START_TIMESTAMP_REVERSE_BY_REVERSE_LIMIT_BY_LIMITList the connected user’s roster records from a start timestamp using the specified ordering direction and result limit.

Input Parameters

integer
required
Maximum number of roster records to return.
boolean
required
Set true to return roster records in reverse order; false for forward order.
integer
required
Documented Deputy path parameter startTimestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_SETUP_APPSGet Deputy setup app configuration available to the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_SETUP_GAMINGFY_BY_ACTIONGet Gamingfy setup data for the selected list or decline operation.

Input Parameters

string ("list" | "decline")
required
Gamingfy operation whose result should be returned: list or decline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_SETUP_GET_STATE_COUNTRY_LISTList Deputy’s supported countries and their states for setup and address selection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_SETUP_SUPPORT_ACCESSGet Deputy support-access status or configuration for the connected user’s account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TASKList tasks available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TASK_COMPLETEDList completed tasks available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TASK_DEPARTMENTGet department-related task data available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TASK_DEPARTMENT_BY_DATEGet department-related task data for the connected Deputy user on the supplied date.

Input Parameters

string
required
Date selecting the department-task data to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TIMESHEET_APPROVE_ALLOW_BY_NUM_OF_TIMESHEETS_TO_APPROVEReturn the approval-allowance result for the requested number of timesheets.

Input Parameters

string
required
Documented Deputy path parameter numOfTimesheetsToApprove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TIMESHEET_BY_START_BY_ENDList the connected user’s timesheets between the specified start and end values.

Input Parameters

string
required
Documented Deputy path parameter end.
string
required
Documented Deputy path parameter start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TIMESHEET_START_TIMESTAMP_BY_START_TIMESTAMP_REVERSE_BY_REVERSE_LIMIT_BY_LIMITList the connected user’s timesheets from a start timestamp using the specified ordering direction and result limit.

Input Parameters

string
required
Maximum number of timesheets to return.
string
required
Provider-defined ordering direction for the returned timesheets.
string
required
Start timestamp from which to return the connected user’s timesheets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TODOList to-do items assigned to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TOKENList Deputy token records available to the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_TRAININGList training records available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_UNAVAIL_BY_START_DATE_BY_END_DATEList the connected Deputy user’s unavailability records between the specified start and end dates.

Input Parameters

string
required
Documented Deputy path parameter endDate.
string
required
Documented Deputy path parameter startDate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_WIDGET_INFOGet Deputy widget metadata available to the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_WIDGET_RUNGet run-related widget data available to the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_MY_WIDGET_RUN_BY_WIDGET_IDGet run information for the specified Deputy widget ID.

Input Parameters

string
required
Deputy widget ID whose run information should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_RESOURCE_AT_TIMEGet one Deputy resource record as it existed at the specified Unix timestamp.

Input Parameters

integer
required
Numeric Deputy resource record ID.
integer
required
Historical point in time as Unix epoch seconds.
string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_RESOURCE_FIELD_METADATAGet Deputy’s field metadata for the selected resource type.

Input Parameters

string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource collection to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_RESOURCE_HISTORYGet the change history for one Deputy resource record.

Input Parameters

integer
required
Numeric Deputy resource record ID.
string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_RESOURCE_RECORDGet one Company, Employee, Leave, OperationalUnit, Roster, or Timesheet record by its numeric ID.

Input Parameters

integer
required
Numeric Deputy resource record ID.
string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_ROSTER_RECOMMENDATIONGet a roster recommendation for the connected employee or supervised employees.

Input Parameters

string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
integer
required
Numeric Deputy roster ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_ROSTER_SWAP_DETAILSGet swap details for a roster belonging to the connected employee or supervised employees.

Input Parameters

string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
integer
required
Numeric Deputy roster ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_COMPANY_BULK_SETTINGS_CHECK_BY_JOB_IDGet the check result for a Deputy bulk company-settings job by job ID.

Input Parameters

string
required
Deputy bulk company-settings job ID returned when the update was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_COMPANY_BY_ID_SETTINGSGet the configured settings for a Deputy company or location by company ID.

Input Parameters

integer
required
Documented Deputy path parameter id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_COMPANY_SIMPLEGet Deputy’s simplified location list for lightweight location selection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_COMPANY_TIMEZONEGet the timezone configured for the connected user’s Deputy company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_DEPARTMENT_CHECK_BY_IDReturn Deputy’s untyped department-check object for the specified department ID. The official capture does not define its fields or a narrower check outcome.

Input Parameters

integer
required
Documented Deputy path parameter id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_DEPARTMENT_LOCATION_BY_IDReturn Deputy’s untyped department-location lookup object for the specified ID. The official capture does not define whether the ID identifies a department or location.

Input Parameters

integer
required
Documented Deputy path parameter id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEEGet full Deputy records for all employees visible to the connected supervisor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_IDGet the Deputy employee record with the specified employee ID.

Input Parameters

integer
required
Numeric Deputy employee ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_CONTRACTEDHOURSGet contracted-hours information for the specified Deputy employee.

Input Parameters

integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_ONBOARDINGGet HR onboarding information for the specified Deputy employee.

Input Parameters

integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_PAYROLL_CONNECTEDRead payroll connection information for the specified Deputy employee.

Input Parameters

integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_PAYROLL_SYNCRead payroll synchronization information for the specified employee without starting a sync.

Input Parameters

integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_MANAGE_LOGINRead login-management information for the specified employee without changing login access.

Input Parameters

integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_VALIDATEGet Deputy’s read-only validation result for the specified employee.

Input Parameters

integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATEList the contracted-hours templates available for supervised employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_DEMOGet the employee demo result exposed by Deputy’s legacy supervisor API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_INVITATIONGet the invitation information returned by Deputy’s zero-input employee invitation endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_REALGet the employee subset Deputy’s legacy API classifies as real employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_REAL_COUNTReturn the count of employees Deputy’s legacy API classifies as real employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPLOYEE_ROLE_MANAGERead the employee-role management data exposed by Deputy; this operation does not change roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_EMPSHIFTINFO_BY_INT_EMP_ID_BY_BLN_ALL_COMPANYGet current shift information for an employee, optionally broadened across all companies by the required scope flag.

Input Parameters

integer
required
Numeric Deputy employee ID whose current shift status should be returned.
string ("true" | "false")
required
Use true to include shift information across all companies, or false to limit the result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_ID_STATUSGet the current recommendation status for a Deputy roster by roster ID.

Input Parameters

integer
required
Numeric Deputy roster ID whose recommendation status should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_LEAVE_BY_INT_EMPLOYEE_IDGet Deputy leave information for the specified employee.

Input Parameters

integer
required
Numeric Deputy employee ID whose leave information should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_LEAVE_BY_INT_EMPLOYEE_ID_BY_STR_SETUPGet leave information for an employee using Deputy’s required leave setup selector.

Input Parameters

string
required
Deputy leave setup selector used to choose the requested leave representation.
integer
required
Numeric Deputy employee ID whose leave setup information should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTERList Deputy rosters from the previous 12 hours through the next 36 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_BY_DATEGet Deputy roster data for the specified date.

Input Parameters

string
required
Roster date in Deputy’s documented date representation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_BY_DATE_BY_INT_COMPANY_IDGet roster data for a Deputy company on the specified date.

Input Parameters

string
required
Documented Deputy path parameter date.
string
required
Deputy company or location ID whose roster data should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_BY_DATE_BY_INT_COMPANY_ID_BY_LIMIT_BY_OFFSET_BY_FETCH_OPENGet a paginated roster result for a Deputy company and date, with an explicit selector for including open rosters.

Input Parameters

string
required
Documented Deputy path parameter date.
string
required
Maximum number of roster records requested from Deputy.
string
required
Number of matching roster records to skip.
string
required
Deputy company or location ID whose roster data should be returned.
string
required
Deputy fetch-open selector controlling whether open roster records are included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_BY_ID_BIDSGet bids for a roster by roster ID.

Input Parameters

integer
required
Documented Deputy path parameter id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_CHECKAUTOBUILD_BY_JOB_KEYGet the status or result of an automatic Deputy roster-build job by job key.

Input Parameters

string
required
Deputy automatic roster-build job key returned when the job was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_CHECKAUTOFILL_BY_JOB_KEYGet the status or result of an automatic Deputy roster-fill job by job key.

Input Parameters

string
required
Deputy automatic roster-fill job key returned when the job was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_NOTIFYMANAGER_BY_IDGet Deputy’s manager-notification information for the specified roster; this GET operation does not send a notification.

Input Parameters

integer
required
Documented Deputy path parameter id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_PENDING_APPROVAL_SWAP_DETAILS_BY_IDGet pending-approval swap details for a roster by roster ID.

Input Parameters

integer
required
Documented Deputy path parameter id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_ROSTER_SYSTEMTEMPLATE_LIST_BY_INT_MODEList Deputy roster system templates using the required provider-defined numeric mode.

Input Parameters

integer
required
Deputy numeric mode selecting which roster system templates are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_TIMESHEET_BULK_CHECK_BY_JOB_IDGet the check result for a Deputy bulk timesheet job by job ID.

Input Parameters

string
required
Deputy bulk timesheet job ID returned when the job was started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_TIMESHEET_BY_EMPLOYEE_ID_BY_DATEGet Deputy timesheet information for an employee on the specified date.

Input Parameters

string
required
Documented Deputy path parameter date.
string
required
Deputy employee ID whose timesheet information should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_SUPERVISE_UNAVAIL_BY_INT_EMPLOYEE_IDGet Deputy unavailability information for the specified employee.

Input Parameters

integer
required
Numeric Deputy employee ID whose unavailability should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_TIMESHEET_DETAILSGet detailed timesheet data for the connected employee or supervised employees.

Input Parameters

string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
integer
required
Numeric Deputy timesheet ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_TIMESHEET_HISTORYGet timesheet change history for the connected employee or supervised employees.

Input Parameters

string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
integer
required
Numeric Deputy timesheet ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_GET_TIMESHEET_SETUPGet timesheet setup information for the connected employee or supervised employees.

Input Parameters

string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
integer
required
Numeric Deputy timesheet ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_COMPANIESList Deputy companies, workplaces, and payroll entities, or return one company when company_id is provided.

Input Parameters

integer
Numeric Deputy company or workplace ID. When set, return only that record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_COMPANY_ROSTER_TEMPLATESList roster templates for a Deputy company without changing them.

Input Parameters

object
required
Provider request object for this operation.
string
required
Deputy company ID whose roster templates to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_EMPLOYEESReturn one page of Deputy employees, or one exact employee when employee_id is provided, without contact, address, payroll, tax, bank, birth, photo, or emergency-contact fields.

Input Parameters

string
Opaque continuation cursor from a previous response. Omit for the first page.
Deputy QUERY clauses keyed by arbitrary clause IDs such as s1. Each clause must contain field, data, and type. Omit to list all visible employees.
integer
Maximum employees in this page (1-500).
integer
Numeric Deputy employee ID. When set, return only that employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_GAMINGFY_ITEMSList Gamingfy setup items without changing their state.

Input Parameters

object
required
Provider request object for this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_LEAVEReturn one page of employee leave records, or one leave record when leave_id is provided, without reasons, comments, medical or attachment data, pay details, or creator profiles.

Input Parameters

string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search.
object
Deputy QUERY clauses keyed by arbitrary clause IDs such as s1. Each clause must contain field, data, and type. Omit to list all visible leave records.
integer
Numeric Deputy leave ID. When set, return only that leave record.
integer
Maximum leave records in this page (1-500).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_OPERATIONAL_UNITSReturn one page of Deputy operational units (areas or departments), or one unit when operational_unit_id is provided.

Input Parameters

string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search.
object
Deputy QueryRequest search expression used to filter records. Use documented resource field names and Deputy query operators; omit to list all visible records.
integer
Maximum records in this page. Must be between 1 and 500.
integer
Numeric Deputy operational unit ID. When set, return that record instead of a list page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_RESOURCE_COMMENTSList comments attached to one Deputy resource record.

Input Parameters

integer
required
Numeric Deputy resource record ID.
string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_RESOURCE_RECORDSList raw Company, Employee, Leave, OperationalUnit, Roster, or Timesheet records. Use the curated list tools when their safer reduced fields are sufficient.

Input Parameters

string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource collection to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_ROSTER_SHIFTSReturn one page of scheduled Deputy roster shifts, or one exact shift when roster_id is provided, without comments, costs, creator profiles, or recursive metadata.

Input Parameters

string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search.
object
Deputy QUERY clauses keyed by arbitrary clause IDs such as s1. Each clause must contain field, data, and type. Omit to list all visible roster shifts.
integer
Maximum roster shifts in this page. Must be between 1 and 500.
integer
Numeric Deputy roster ID. When set, return that record instead of a list page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_ROSTER_SWAPSList roster swaps in a date range for the connected employee or supervised employees.

Input Parameters

string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
string
required
End date for the roster-swap range.
string
required
Start date for the roster-swap range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_LIST_TIMESHEETSReturn one page of timesheet records, or one timesheet when a timesheet ID is provided. Preserve Deputy’s ISO date, epoch-second start/end times, and decimal-hour total while omitting comments and pay amounts or rates.

Input Parameters

string
Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search.
object
Deputy QueryRequest search expression used to filter records. Use documented Timesheet resource field names and Deputy query operators; omit to list all visible records.
integer
Maximum records in this page. Must be between 1 and 500.
integer
Numeric Deputy timesheet ID. When set, return that record instead of a list page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_COLLEAGUE_QUERYSearch colleague records visible to the connected Deputy user using a Deputy query object.

Input Parameters

object
required
JSON object documented for POST /v1/my/colleague/QUERY. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_colleague__query_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_CONTACTADDRESSCreate or update contact-address data for the connected Deputy user. Verify the request values before saving it.

Input Parameters

object
required
JSON object documented for POST /v1/my/contactaddress. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_contactaddress__post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_CONTACTADDRESS_EMERGENCYUpdate emergency contact information for the connected Deputy user. Verify the request values before updating it.

Input Parameters

object
required
JSON object documented for POST /v1/my/contactaddress/emergency. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_contactaddress__emergency_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_LOCATION_PENDING_APPROVAL_QUERYQuery locations awaiting approval for the connected Deputy user using a Deputy query object.

Input Parameters

object
required
JSON object documented for POST /v1/my/location/pending-approval/QUERY. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_location__pending_approval_query_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_MEMOApply provider-defined changes to the connected Deputy user’s memo or newsfeed state. This endpoint does not create memos; Deputy documents PUT /v1/supervise/memo for creation.

Input Parameters

object
required
Provider-defined JSON object for POST /v1/my/memo. Deputy does not document its fields; this is not the memo-creation route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_MEMO_BY_ID_COMMENTAdd a comment to the specified memo for the connected user. Verify the memo ID and comment content before creating it.

Input Parameters

integer
required
Numeric Deputy memo ID to comment on.
object
required
JSON object documented for POST /v1/my/memo/{id}/comment. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_memo__id_comment_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_MEMO_COMPANY_BY_IDApply the supplied memo change for the specified Deputy company. Verify the company ID and request values before updating it.

Input Parameters

object
required
JSON object documented for POST /v1/my/memo/company/{id}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_memo__company_id_post.
string
required
Deputy company ID targeted by the memo operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_MEMO_SUMMARYUpdate memo summary state for the connected Deputy user using the supplied request values.

Input Parameters

object
required
JSON object documented for POST /v1/my/memo/summary. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_memo__summary_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_MEMO_TEAM_BY_IDApply the supplied memo change for the specified Deputy team. Verify the team ID and request values before updating it.

Input Parameters

object
required
JSON object documented for POST /v1/my/memo/team/{id}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_memo__team_id_post.
string
required
Deputy team ID targeted by the memo operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_MEMO_USER_BY_IDApply the supplied memo change for the specified Deputy user. Verify the user ID and request values before updating it.

Input Parameters

object
required
JSON object documented for POST /v1/my/memo/user/{id}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_memo__user_id_post.
string
required
Deputy user ID targeted by the memo operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_NPSCreate or update the connected Deputy user’s Net Promoter Score response.

Input Parameters

object
required
JSON object documented for POST /v1/my/nps. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_nps__post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_NPS_LATERPostpone the connected Deputy user’s NPS response or prompt.

Input Parameters

object
required
JSON object documented for POST /v1/my/nps/later. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_nps__later_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_PHOTO_BY_NAMEUpdate the connected Deputy user’s named photo using the supplied photo request body.

Input Parameters

object
required
JSON object documented for POST /v1/my/photo/{name}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_photo__name_post.
string
required
Provider-defined name identifying the connected user’s photo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_PREF_BY_PREF_KEYUpdate the connected Deputy user’s named preference using the supplied preference value.

Input Parameters

object
required
JSON object documented for POST /v1/my/pref/{prefKey}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_pref__prefkey_post.
string
required
Preference key to update for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_PREF_UPDATE_SUPPORT_ACCESSChange Deputy support access for the connected user’s account using the supplied support-access setting.

Input Parameters

object
required
JSON object documented for POST /v1/my/pref/update-support-access. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_pref__update_support_access_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_ROSTER_BIDS_REQUESTCreate pending bids for the connected employee on eligible published open rosters that require approval.

Input Parameters

array
required
Published open roster IDs that require approval and are eligible for the connected employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_ROSTER_BIDS_WITHDRAWChange the connected employee’s pending bids on the specified rosters to withdrawn. Verify the roster IDs before updating them.

Input Parameters

array
required
Roster IDs with pending bids belonging to the connected employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_ROSTER_BY_ID_OFFERCreate an offer for the specified roster record using the supplied offer details. Verify the roster ID before updating it.

Input Parameters

object
required
JSON object documented for POST /v1/my/roster/{id}/offer. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_roster__id_offer_post.
integer
required
Numeric Deputy roster ID to offer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_ROSTER_BY_ID_OFFER_CANCELCancel the existing offer for the specified roster record. Verify the roster ID before updating it.

Input Parameters

object
required
JSON object documented for POST /v1/my/roster/{id}/offer/cancel. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_roster__id_offer_cancel_post.
integer
required
Numeric Deputy roster ID whose offer should be cancelled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_ROSTER_BY_ID_SWAP_BY_ACTIONRequest, cancel, accept, recommend, decline, or decline all for the specified roster swap. Verify the roster ID and selected operation before updating it.

Input Parameters

object
required
JSON object documented for POST /v1/my/roster/{id}/swap/{action}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_roster__id_swap_action_post.
integer
required
Numeric Deputy roster ID whose swap state should be changed.
string ("request" | "cancel" | "accept" | "recommendation" | "decline" | "declineall")
required
Roster-swap operation to apply: request, cancel, accept, recommendation, decline, or declineall.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_ROSTER_OPENAssign eligible published open rosters that do not require approval to the connected employee, closing those openings. Verify the roster IDs before updating them.

Input Parameters

array
required
Published open roster IDs that do not require approval and are eligible for the connected employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_SETUP_ADD_NEW_WORKPLACECreate a new workplace in the connected Deputy account using the supplied workplace details.

Input Parameters

object
required
JSON object documented for POST /v1/my/setup/addNewWorkplace. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_setup__addnewworkplace_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_SETUP_GET_ADDRESS_TIMEZONE_FROM_GEOResolve an address and timezone from the supplied geographic coordinates without changing Deputy data.

Input Parameters

number
required
Latitude to resolve, sent to Deputy as lat.
number
required
Longitude to resolve, sent to Deputy as lon.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_SETUP_GET_GEO_TIMEZONE_FROM_ADDRESSResolve geographic coordinates and a timezone from the supplied address without changing Deputy data.

Input Parameters

object
required
JSON object documented for POST /v1/my/setup/getGeoTimezoneFromAddress. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_setup__getgeotimezonefromaddress_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_SETUP_SEND_EMAIL_TO_CXImmediately send the supplied email to Deputy Customer Experience. Email delivery is external and cannot be undone.

Input Parameters

object
required
JSON object documented for POST /v1/my/setup/sendEmailToCX. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_setup__sendemailtocx_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_SETUP_SFSubmit setup data to Deputy’s legacy setup route and return its untyped result object. The official capture does not define a more specific state transition.

Input Parameters

object
required
JSON object documented for POST /v1/my/setup/sf. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_setup__sf_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_SETUP_VALIDATE_WORKPLACEValidate the supplied Deputy workplace details and return the result without changing the workplace.

Input Parameters

object
required
JSON object documented for POST /v1/my/setup/validateWorkplace. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_setup__validateworkplace_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_TASKApply provider-defined changes to the connected Deputy user’s task state. This endpoint does not create tasks; Deputy documents POST /v1/resource/Task for creation.

Input Parameters

object
required
Provider-defined JSON object for POST /v1/my/task. Deputy does not document its fields; this is not the task-creation route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_TASK_BY_IDUpdate the specified task for the connected Deputy user using the supplied request values.

Input Parameters

object
required
JSON object documented for POST /v1/my/task/{id}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_task__id_post.
integer
required
Numeric Deputy task ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_TASK_COMPLETEDApply the supplied completion change to tasks for the connected Deputy user.

Input Parameters

object
required
JSON object documented for POST /v1/my/task/completed. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_task__completed_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_TASK_DEPARTMENTApply the supplied department-task change for the connected Deputy user.

Input Parameters

object
required
JSON object documented for POST /v1/my/task/department. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_task__department_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_TASK_DEPARTMENT_BY_DATEApply the supplied department-task change for the connected Deputy user on the specified date.

Input Parameters

string
required
Date selecting the department-task records to change.
object
required
JSON object documented for POST /v1/my/task/department/{date}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_task__department_date_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_TODOCreate or update a to-do item for the connected Deputy user. Verify the request values before saving it.

Input Parameters

object
required
JSON object documented for POST /v1/my/todo. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_todo__post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_MY_UNAVAILCreate or update an unavailability record for the connected Deputy user. Verify the request values before saving it.

Input Parameters

object
required
JSON object documented for POST /v1/my/unavail. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_unavail__post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_COMPANY_ALL_SETTINGSUpdate the week-start setting across all Deputy locations. Verify the value before applying the broad change.

Input Parameters

integer
Deputy weekday number to set as the start of the week for all locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_COMPANY_BY_IDUpdate documented fields for a Deputy company or location by ID.

Input Parameters

integer
required
Numeric Deputy company or location ID to update.
string
Replacement address or place description.
string
Replacement IANA timezone.
integer
Deputy integer flag indicating whether the location is a workplace.
string
Replacement notes supplementing the address.
string
Replacement short workplace code.
string
Replacement workplace or location name.
integer
Deputy integer flag indicating whether the location is a payroll entity.
integer
Replacement parent Deputy company ID.
string
Replacement payroll export code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_ARCHIVEArchive the selected Deputy company or location so it is no longer active; verify the company ID before running.

Input Parameters

integer
required
Documented Deputy path parameter id.
object
required
JSON object documented for POST /v1/supervise/company/{id}/archive. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_company__id_archive_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_CASCADE_SETTINGSUpdate documented settings for a Deputy company and cascade those values to eligible child records.

Input Parameters

integer
required
Documented Deputy path parameter id.
object
required
JSON object documented for POST /v1/supervise/company/{id}/cascade/settings. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_company__id_cascade_settings_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_DELETEPermanently delete the Deputy company or location identified by company ID; verify the target before running.

Input Parameters

integer
required
Documented Deputy path parameter id.
object
required
JSON object documented for POST /v1/supervise/company/{id}/delete. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_company__id_delete_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_GOOGLE_PLACE_ID_BY_GOOGLE_PLACE_IDSet or replace the Google Place ID associated with a Deputy company or location.

Input Parameters

string
required
Documented Deputy path parameter id.
object
required
JSON object documented for POST /v1/supervise/company/{id}/googlePlaceId/{googlePlaceId}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_company__id_googleplaceid_googleplaceid_post.
string
required
Google Place ID to associate with the Deputy company or location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_SETTINGSUpdate the week-start setting for a Deputy company or location by company ID.

Input Parameters

integer
required
Documented Deputy path parameter id.
integer
Deputy weekday number to set as the start of the week for this location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_DEPARTMENT_ALL_BY_LOCATION_IDUpdate the collection of department records associated with the specified Deputy location and return Deputy’s untyped result object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/department/all/{locationId}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_department__all_locationid_post.
integer
required
Numeric Deputy location ID whose departments are targeted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_DEPARTMENT_BY_IDUpdate a Deputy department by ID, supplying its location and name and optionally its address, payroll export name, display order, or area type.

Input Parameters

integer
required
Numeric Deputy department or operational-unit ID to update.
string
Replacement department address.
integer
required
Destination Deputy location or company ID.
integer
Replacement department display order.
string
Replacement payroll export name.
string
required
Replacement department or area name.
integer
Department type: 0 for a default area or 1 for a geo-based area.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEECreate a Deputy employee using the supplied name, location, and optional employment details.

Input Parameters

integer ("0" | "1" | "2" | "3")
Gender code: 0 prefer not to say, 1 male, 2 female, or 3 non-binary.
string
required
Employee last name.
integer
required
Deputy location ID to which the employee should be added.
string
required
Employee first name.
string
Optional payroll identifier for the employee.
string
Employee start date in YYYY-MM-DD format.
string
Country code for the employee’s address.
string
Employee mobile phone number.
integer
Optional weekday pay rate accepted by Deputy.
string
Employee date of birth in Deputy’s documented representation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_AMEND_ABPUpdate employee data through Deputy’s legacy amendment route and return its untyped result object. The official capture does not define the affected employee fields.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/amendABP. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__amendabp_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_IDUpdate the phone value for an existing Deputy employee by employee ID.

Input Parameters

string
required
Replacement phone value documented by Deputy for this employee update.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_ACTIVATEReactivate a terminated Deputy employee, returning the employee to active status.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/activate. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_activate_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_CONTRACTEDHOURSApply Deputy’s documented contracted-hours mutation to an existing employee.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/contractedhours. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_contractedhours_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_DELETEPermanently delete the selected employee’s Deputy account; unlike termination, this removes the account record and cannot be undone.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/delete. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_delete_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_ONBOARDINGAssign an HR onboarding record ID to the specified Deputy employee.

Input Parameters

integer
required
Documented Deputy path parameter employeeId.
string
required
HR onboarding record ID to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_PAYROLL_SYNCRun Deputy’s documented HR payroll synchronization operation for the specified employee; verify payroll inputs before running.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/hr/payroll/sync. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_hr_payroll_sync_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_INVITEInvite the selected employee to Deputy, sending a one-way external invitation that cannot be recalled; verify the employee ID and invitation details first.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/invite. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_invite_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_PHOTOUpdate the selected employee’s photo using Deputy’s documented photo object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/photo. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_photo_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_RESET_2FAReset the selected employee’s two-factor authentication, invalidating the current second-factor setup so it must be configured again.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/reset-2fa. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_reset_2fa_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SENDLOGINSend Deputy’s login communication to the selected employee; the external message cannot be recalled. Use invitation or account reset instead when those are the intended effects.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/sendlogin. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_sendlogin_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SEND_RESET_ACCOUNTSend the selected employee Deputy’s account-reset communication; this security-sensitive external message cannot be recalled.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/send-reset-account. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_send_reset_account_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SET_AWARD_FROM_LIBRARYApply an award from Deputy’s library to selected employment agreements; if no agreement IDs are supplied, Deputy updates all agreements for the employee.

Input Parameters

string
required
Deputy library award code to apply.
integer
required
Documented Deputy path parameter employeeId.
string
required
Country code used to select an award from Deputy’s award library.
array
Employment agreement record IDs to update. Omit to update all agreements for the employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SET_AWARD_FROM_TEMPLATEApply a proven Deputy award contract template to selected employee agreements.

Input Parameters

integer
required
Deputy award contract template ID to apply.
integer
required
Documented Deputy path parameter employeeId.
array
Employment agreement record IDs to update. Omit to update all agreements for the employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_TERMINATETerminate the specified Deputy employee. This changes employment status but is distinct from deleting the employee account.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/{employeeId}/terminate. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_terminate_post.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATEApply Deputy’s documented mutation to a contracted-hours template using the supplied template object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/contractedhours/template. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__contractedhours_template_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATE_BY_TEMPLATE_IDUpdate a Deputy contracted-hours template by template ID using the supplied documented fields.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/contractedhours/template/{templateId}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__contractedhours_template_templateid_post.
integer
required
Documented Deputy path parameter templateId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_CREATECreate one or more Deputy employees with each employee’s first name, last name, and location ID.

Input Parameters

array
required
One or more employees to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_INVITATIONProcess an employee invitation using Deputy’s documented invitation payload; use validation first when the payload is untrusted.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/invitation. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__invitation_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_QUERYSearch supervised employees using Deputy’s employee query filters and return matching employee records.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/QUERY. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__query_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_RESET_GENDERReset employee gender data using Deputy’s documented reset object; verify the target data before running.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/reset/gender. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__reset_gender_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_EMPLOYEE_VALIDATEValidate employee data before creating or updating an employee; this check does not change workforce records.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/employee/validate. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__validate_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_IDUpdate employee recommendations for the specified roster using the supplied object and return Deputy’s untyped result object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/getrecommendation/{intRosterId}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_getrecommendation__introsterid_post.
integer
required
Numeric Deputy roster ID whose recommendations should be changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_ID_RESETReset recommendations for a roster. This changes workforce recommendation state; verify the roster ID and payload before running it.

Input Parameters

object
required
Required reset payload documented by Deputy for the selected roster recommendation.
integer
required
Roster ID whose recommendations should be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_GET_ROSTER_TIMESHEETCreate or update Deputy’s documented roster-timesheet record using the supplied relationship object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/get-roster-timesheet. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_get_roster_timesheet__post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_LEAVE_LEAVE_MANAGEMENTUpdate leave-management state for the leave record or request identified in the supplied object and return Deputy’s untyped result object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/leave/leaveManagement. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_leave__leavemanagement_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTERCreate or update a Deputy roster using the supplied documented roster object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/roster. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_roster__post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_AUTOBUILDStart an asynchronous job that creates unpublished Deputy shifts for selected areas and dates using staffing, coverage, or historical demand.

Input Parameters

string ("RequiredStaff" | "MinimumCoverage" | "Historical")
required
Scheduling metric Deputy should use to generate shifts.
array
required
Preferred shift lengths in hours, ordered by priority.
number
required
Generated shift granularity in hours: 0.25, 0.5, or 1.0.
integer
required
Period end as a Unix timestamp in seconds.
integer
required
Period start as a Unix timestamp in seconds.
array
required
One or more area or operational-unit IDs in which to generate shifts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_AUTOBUILDFROMAGREEDHOURSCreate Deputy shifts from selected employees’ agreed-hours profiles for specified areas, locations, and dates.

Input Parameters

string
required
Last schedule date in YYYY-MM-DD format.
string
required
First schedule date in YYYY-MM-DD format.
array
required
One or more Deputy location or company IDs for the generated shifts.
array
required
One or more employees whose agreed hours should become shifts.
array
required
One or more area or operational-unit IDs in which to create agreed-hours shifts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_AUTOBUILDFROMGFEStart Deputy’s documented GFE-based automatic roster-build operation using the supplied inputs.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/roster/autobuildfromgfe. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_roster__autobuildfromgfe_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_AUTOFILLStart an asynchronous job that assigns candidate employees to selected open Deputy shifts using bounded search and optimization settings.

Input Parameters

object
required
Required optimization object; each cost, equality, and prior-match flag is optional.
array
required
One or more open roster IDs to fill, up to 1000 shifts.
array
required
One or more candidate Deputy employee IDs.
integer
required
Permutation search depth; larger values can take longer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_CANCELAUTOFILLCancel the roster autofill operation identified by the supplied Deputy cancellation object.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/roster/cancelautofill. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_roster__cancelautofill_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_CHECKAUTOBUILDFROMAGREEDHOURS_BY_JOB_KEYCheck or advance Deputy’s documented roster autobuild-from-agreed-hours job using its job key and request object.

Input Parameters

string
required
Deputy job key for the roster autobuild-from-agreed-hours operation.
object
required
JSON object documented for POST /v1/supervise/roster/checkautobuildfromagreedhours/{jobKey}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_roster__checkautobuildfromagreedhours_jobkey_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_CHECKAUTOBUILDFROMGFE_BY_JOB_KEYCheck or advance Deputy’s documented GFE-based roster-autobuild job using its job key and request object.

Input Parameters

string
required
Deputy job key for the GFE-based automatic roster-build operation.
object
required
JSON object documented for POST /v1/supervise/roster/checkautobuildfromgfe/{jobKey}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_roster__checkautobuildfromgfe_jobkey_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_COPYCopy Deputy roster data using the supplied source and destination settings.

Input Parameters

string
required
Destination roster date in YYYY-MM-DD format.
string
required
Source roster start date in YYYY-MM-DD format.
array
required
Deputy operational-unit IDs whose rosters should be copied.
integer ("0" | "1")
Set to 1 to request detailed copy errors, or 0 otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_COPY_BATCHCopy multiple rosters in one request using the supplied source and destination settings; verify every roster target before running.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/roster/copy/batch. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_roster__copy_batch_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_DISCARDDiscard the Deputy roster state selected by the supplied documented object; verify the target before running.

Input Parameters

array
required
Deputy roster record IDs to discard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_ROSTER_PUBLISHPublish selected Deputy rosters or rosters across all locations, making the schedule externally visible.

Input Parameters

integer
required
Deputy roster publication mode.
array
required
Deputy roster record IDs to publish.
integer ("0" | "1")
required
Set to 1 to publish rosters for all locations, or 0 to use the selected roster IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_TIMESHEET_BULK_RECALCULATERecalculate the selected timesheets in bulk; verify the timesheet selection and recalculation inputs before updating them.

Input Parameters

object
required
JSON object documented for POST /v1/supervise/timesheet/bulk/recalculate. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_timesheet__bulk_recalculate_post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_TIMESHEET_ENDClock off an employee and end the selected active timesheet using Deputy’s documented clock-off object.

Input Parameters

integer
required
Numeric Deputy timesheet ID to stop.
integer
required
Number of meal-break minutes taken during the timesheet period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_TIMESHEET_PAUSEToggle an employee timesheet between paused and resumed break states. This endpoint does not set a requested state and is non-idempotent: verify the current state before calling, and do not retry automatically because a repeated call can reverse the intended change.

Input Parameters

integer
required
Numeric Deputy timesheet ID to pause or resume.
integer
required
Meal-break minutes supplied for the pause or resume transition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_POST_SUPERVISE_TIMESHEET_STARTClock on an employee and start a timesheet using Deputy’s documented clock-on object.

Input Parameters

integer
required
Numeric Deputy employee ID to clock on.
integer
required
Deputy operational-unit or area ID for the timesheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_MY_NPSSubmit a Net Promoter Score response for the connected Deputy user.

Input Parameters

object
required
JSON object documented for PUT /v1/my/nps. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_nps__put.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_MY_PREF_BY_PREF_KEYSet the connected Deputy user’s preference identified by key to the supplied value.

Input Parameters

object
required
JSON object documented for PUT /v1/my/pref/{prefKey}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_pref__prefkey_put.
string
required
Preference key to set for the connected Deputy user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_SUPERVISE_COMPANYAdd a Deputy location with its workplace name, address, and optional workplace, timezone, parent-company, and payroll settings.

Input Parameters

string
required
Street address or place description for the location.
string
Optional IANA timezone, such as Australia/Sydney.
integer
Deputy integer flag indicating whether this location is a workplace.
string
Optional notes that supplement the address.
string
Optional short workplace code.
string
required
Name of the new Deputy workplace or location.
integer
Deputy integer flag indicating whether this location is a payroll entity.
integer
Optional parent Deputy company ID.
string
Optional payroll export code for this location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_SUPERVISE_DEPARTMENTCreate a Deputy department from the supplied documented department fields.

Input Parameters

string
Optional address for the department or area.
integer
Location ID to which the department belongs.
integer
Optional display order for the department.
string
Optional payroll export name for the department.
integer
Optional location ID for the department.
string
required
Name of the Deputy department or area to create.
integer
Deputy department type: 0 for default or 1 for a geo-based area.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_SUPERVISE_DEPARTMENT_CREATECreate multiple Deputy departments from the supplied documented department data.

Input Parameters

array
required
Departments to create in one request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_SUPERVISE_EMPLOYEECreate a Deputy employee using the supplied documented employee fields.

Input Parameters

object
required
JSON object documented for PUT /v1/supervise/employee. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__put.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_CONTRACTEDHOURSUpdate contracted-hours details for an existing Deputy employee by employee ID; verify the employee and effective hours before running.

Input Parameters

object
required
JSON object documented for PUT /v1/supervise/employee/{employeeId}/contractedhours. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_contractedhours_put.
integer
required
Documented Deputy path parameter employeeId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATECreate a Deputy contracted-hours template using the supplied documented template object.

Input Parameters

object
required
JSON object documented for PUT /v1/supervise/employee/contractedhours/template. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__contractedhours_template_put.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_PUT_SUPERVISE_EMPLOYEE_VALIDATEValidate the supplied employee object through Deputy’s legacy PUT validation route and return the validation result.

Input Parameters

object
required
JSON object documented for PUT /v1/supervise/employee/validate. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__validate_put.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_REPLACE_RESOURCE_RECORDReplace an existing Employee, Leave, OperationalUnit, Roster, or Timesheet record with a non-atomic safety check. The tool reads the current record twice, rejects changes detected before the write, merges only explicitly supplied typed fields into Deputy’s documented fields, validates the complete merged record and provider-evidenced nullability, then PUTs it. Deputy offers no conditional PUT, so a change after the final read can still race.

Input Parameters

string
required
Partial typed Deputy record changes. resource_type selects the matching endpoint and schema.
integer
required
Numeric Deputy resource record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_REPLACE_UNAVAILABILITYReplace a self or supervised employee unavailability record by ID. Verify the target and complete replacement object first.

Input Parameters

object
required
Complete replacement object documented by Deputy for the unavailability record.
string ("self" | "supervised")
required
Use self for the connected employee or supervised for employees they supervise.
string
required
Deputy unavailability record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_SAVE_COMPANY_ROSTER_TEMPLATESave changes to roster-template data for a Deputy company.

Input Parameters

object
required
Provider request object for this operation.
string
required
Deputy company ID whose roster templates to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_SEARCH_RESOURCE_RECORDSSearch one Deputy resource type with typed filters, sorting, offset pagination, and optional related-record expansion.

Input Parameters

array
Related ORM names to expand inline, such as EmployeeObject.
object
Deputy field names mapped to asc or desc.
integer
Zero-based result offset.
object
Search clauses keyed by a stable label such as s1 or employee_filter.
integer
Maximum records to return; Deputy caps this at 500.
string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet")
required
Resource type to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_SET_EMPLOYEE_WORKPLACE_ASSOCIATIONAssociate an employee with a workplace or remove that relationship. Verify both IDs before changing it.

Input Parameters

boolean
required
True to associate the employee with the workplace; false to remove the association.
integer
required
Numeric Deputy employee ID.
boolean
Whether to make the workplace primary when associating.
integer
Agreement ID to assign when associating. Omit to create a new agreement.
integer
required
Numeric Deputy workplace or location ID.
object
Deputy request object required when removing an association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_SET_MEMO_READ_STATEMark a memo log read or unread for the connected Deputy user.

Input Parameters

string ("read" | "unread")
required
Desired memo-log read state.
integer
required
Numeric Deputy memo ID.
object
required
Request object required by Deputy for the memo read-state transition.
integer
required
Numeric memo-log ID whose read state to set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_SET_TASK_COMPLETIONComplete or restore a task belonging to the connected Deputy user.

Input Parameters

object
required
Request object required by Deputy for the task transition.
integer
required
Numeric Deputy task ID.
boolean
required
True to perform the task’s do transition; false to undo it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPUTY_UPDATE_RESOURCE_RECORDUpdate an existing Employee, Leave, OperationalUnit, Roster, or Timesheet record using Deputy’s documented complete resource schema.

Input Parameters

string
required
Complete typed Deputy record. resource_type selects the matching endpoint and schema.
integer
required
Numeric Deputy resource record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not