--- canonical_url: "https://docs.composio.dev/toolkits/deputy" markdown_url: "https://docs.composio.dev/toolkits/deputy.md" product: "platform" version: null last_updated: null --- # Deputy Manage workforce scheduling, employees, timesheets, leave, locations, and other tenant resources in Deputy. - **Category:** human resources - **Auth:** OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 247 - **Triggers:** 0 - **Slug:** `DEPUTY` - **Version:** 00000000_00 ## Tools ### Add resource comment **Slug:** `DEPUTY_ADD_RESOURCE_COMMENT` Add comment text to one Deputy resource record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment` | string | Yes | Comment text to add to the record. | | `record_id` | integer | Yes | Numeric Deputy resource record ID. | | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Apply Timesheet Operation **Slug:** `DEPUTY_APPLY_TIMESHEET_OPERATION` Apply 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Request object documented by Deputy for the selected non-clock timesheet operation. | | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `operation` | string ("update" | "dispute" | "ipamend" | "approve" | "discard") | Yes | Timesheet operation to apply. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk create or update resource records **Slug:** `DEPUTY_BULK_UPSERT_RESOURCE_RECORDS` Create or update multiple records of one resource type. Deputy processes each record independently, so inspect every item result for partial failures. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `records` | array | Yes | Typed records to create or update. All must match resource_type. | | `resource_type` | string ("employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type shared by every record in the batch. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Company Roster Template **Slug:** `DEPUTY_COPY_COMPANY_ROSTER_TEMPLATE` Create a roster-template copy for a Deputy company from the supplied template data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Provider request object for this operation. | | `company_id` | string | Yes | Deputy company ID whose roster templates to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Employee Leave **Slug:** `DEPUTY_CREATE_EMPLOYEE_LEAVE` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | integer ("1" | "2") | Yes | Creation action: 1 creates approved leave; 2 creates declined leave. Deputy rejects 0 and 3 on this create route. | | `end_date` | string | Yes | End date of the employee leave in YYYY-MM-DD format. | | `start_date` | string | Yes | Start date of the employee leave in YYYY-MM-DD format. | | `employee_id` | integer | Yes | Numeric Deputy employee ID for the leave record. | | `approval_comment` | string | Yes | Comment regarding approval or disposition of the leave. | | `overlapping_rosters_action` | integer | Yes | Deputy action code controlling how overlapping rosters are handled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Employee Unavailability **Slug:** `DEPUTY_CREATE_EMPLOYEE_UNAVAILABILITY` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment` | string | Yes | Comment explaining the employee's unavailability. | | `employee_id` | integer | Yes | Numeric Deputy employee ID for the unavailability record. | | `end_timestamp` | integer | Yes | End of the unavailability as a Unix timestamp. | | `recurrence_day` | string | Yes | Recurrence day code, such as MO for Monday. | | `start_timestamp` | integer | Yes | Start of the unavailability as a Unix timestamp. | | `recurrence_interval` | integer | Yes | Number of recurrence-frequency units between occurrences. | | `recurrence_frequency` | string | Yes | Recurrence frequency, such as WEEKLY. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or replace resource record **Slug:** `DEPUTY_CREATE_OR_REPLACE_RESOURCE_RECORD` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record` | string | Yes | Typed Deputy record to create or replace. resource_type selects the matching endpoint and schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create resource record **Slug:** `DEPUTY_CREATE_RESOURCE_RECORD` Create an Employee, Leave, OperationalUnit, Roster, or Timesheet record from typed agent-facing fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record` | string | Yes | Typed Deputy record to create. resource_type selects the matching endpoint and schema. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Decline Gamingfy Item **Slug:** `DEPUTY_DECLINE_GAMINGFY_ITEM` Decline the Gamingfy item identified by the supplied request object, changing its state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Provider request object for this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete My Memo Comment **Slug:** `DEPUTY_DELETE_MY_MEMO_BY_ID_COMMENT_BY_COMMENT_ID` Delete a comment from the specified memo. Verify the memo and comment IDs before deleting it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `memo_id` | integer | Yes | Numeric Deputy memo ID containing the comment. | | `comment_id` | integer | Yes | Numeric Deputy memo comment ID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete My Preference **Slug:** `DEPUTY_DELETE_MY_PREF_BY_PREF_KEY` Delete one preference for the connected Deputy user by preference key. Verify the key before deleting it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pref_key` | string | Yes | Preference key to delete for the connected Deputy user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete My To-Do Item **Slug:** `DEPUTY_DELETE_MY_TODO_BY_TODO_ID` Delete a to-do item belonging to the connected user by its numeric ID. Verify the ID before deleting it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `todo_id` | integer | Yes | Numeric Deputy to-do item ID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete My Token **Slug:** `DEPUTY_DELETE_MY_TOKEN_BY_STR_ID_OR_TOKEN` Invalidate the Deputy token identified by its documented token ID or token value. Verify the target before deleting it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `token_id_or_value` | string | Yes | Documented Deputy token ID or token value to invalidate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete resource comment **Slug:** `DEPUTY_DELETE_RESOURCE_COMMENT` Permanently delete one comment from a Deputy resource record. Verify both IDs first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | integer | Yes | Numeric Deputy resource record ID. | | `comment_id` | integer | Yes | Numeric ID of the comment to delete. | | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete resource record **Slug:** `DEPUTY_DELETE_RESOURCE_RECORD` Permanently delete an Employee, Leave, OperationalUnit, Roster, or Timesheet record by ID. Verify the resource type and record ID first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | integer | Yes | Numeric Deputy resource record ID. | | `resource_type` | string ("employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Department **Slug:** `DEPUTY_DELETE_SUPERVISE_DEPARTMENT_BY_ID` Permanently delete the Deputy department identified by department ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Contracted-Hours Template **Slug:** `DEPUTY_DELETE_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATE_BY_TEMPLATE_ID` Permanently delete an employee contracted-hours template by template ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `template_id` | integer | Yes | Documented Deputy path parameter templateId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Employee Invitations **Slug:** `DEPUTY_DELETE_SUPERVISE_EMPLOYEE_INVITATION` Delete the employee invitation data selected by Deputy's zero-input invitation endpoint; deletion is irreversible. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Roster Template **Slug:** `DEPUTY_DELETE_SUPERVISE_ROSTER_TEMPLATE_BY_TEMPLATE_ID` Permanently delete a Deputy roster template by template ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `template_id` | integer | Yes | Documented Deputy path parameter templateId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Unavailability **Slug:** `DEPUTY_DELETE_UNAVAILABILITY` Permanently delete a self or supervised employee unavailability record by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `unavailability_id` | integer | Yes | Numeric Deputy unavailability record ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find matching resource record **Slug:** `DEPUTY_FIND_MATCHING_RESOURCE_RECORD` Find the closest existing record matching a partial typed record before deciding whether to create or update it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record` | string | Yes | Partial typed Deputy record used to find the closest existing match. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Workplace Setup **Slug:** `DEPUTY_GET_CURRENT_USER` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Department Weather **Slug:** `DEPUTY_GET_DEPARTMENT_WEATHER` Get current weather or weather for a specified date for one Deputy department. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Optional date in YYYY-M-D or YYYY-MM-DD format. Omit for current weather. | | `department_id` | integer | Yes | Numeric Deputy department ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Location Weather **Slug:** `DEPUTY_GET_LOCATION_WEATHER` Get current weather or weather for a specified date for locations in one Deputy company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Optional date in YYYY-M-D or YYYY-MM-DD format. Omit for current weather. | | `company_id` | integer | Yes | Numeric Deputy company ID whose location weather to get. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get OAuth Identity **Slug:** `DEPUTY_GET_ME` Get OAuth Identity. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Colleagues **Slug:** `DEPUTY_GET_MY_COLLEAGUE` List colleagues visible to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count My Colleagues **Slug:** `DEPUTY_GET_MY_COLLEAGUE_COUNT` Return the number of colleagues visible to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Contact Addresses **Slug:** `DEPUTY_GET_MY_CONTACTADDRESS` List contact addresses available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List All My Contact Addresses **Slug:** `DEPUTY_GET_MY_CONTACTADDRESS_ALL` List all contact addresses available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Emergency Contact Addresses **Slug:** `DEPUTY_GET_MY_CONTACTADDRESS_EMERGENCY` Get emergency contact addresses for the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Subordinate Contact Addresses **Slug:** `DEPUTY_GET_MY_CONTACTADDRESS_SUBORDINATE` Get contact addresses for employees subordinate to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Subordinate Contact Addresses **Slug:** `DEPUTY_GET_MY_CONTACTADDRESS_SUBORDINATE_BY_INT_COMPANY_ID` Get subordinate contact addresses for the specified Deputy company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_id` | integer | Yes | Deputy company ID whose subordinate contact addresses should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Department **Slug:** `DEPUTY_GET_MY_DEPARTMENT_BY_INT_DEPT_ID` Get a Deputy department by its department ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `department_id` | string | Yes | Deputy department ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Feed By Range **Slug:** `DEPUTY_GET_MY_FEED_RANGE_BY_START_TO_BY_END` Get feed records for the connected Deputy user over the supplied start-to-end interval. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end` | string | Yes | Documented Deputy path parameter end. | | `start` | string | Yes | Documented Deputy path parameter start. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Feed By Date **Slug:** `DEPUTY_GET_MY_FEED_SINGLE_BY_DATE` Get feed records for the connected Deputy user on the specified date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Documented Deputy path parameter date. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Feed Summary By Range **Slug:** `DEPUTY_GET_MY_FEED_SUMMARY_BY_START_TO_BY_END` Get a summary of the connected Deputy user's feed over the supplied start-to-end interval. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end` | string | Yes | Documented Deputy path parameter end. | | `start` | string | Yes | Documented Deputy path parameter start. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Leave By Setup **Slug:** `DEPUTY_GET_MY_LEAVE_BY_STR_SETUP` Get leave data for the connected Deputy user using the specified setup selector. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `setup` | string | Yes | Deputy leave setup selector used to choose the leave data returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List All Locations **Slug:** `DEPUTY_GET_MY_LOCATION_ALL` List all locations available to the connected Deputy account. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Locations By Company **Slug:** `DEPUTY_GET_MY_LOCATION_BY_INT_COMPANY_ID` Get location records for the specified Deputy company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_id` | string | Yes | Deputy company ID whose locations should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Location Kiosk Authentication Modes **Slug:** `DEPUTY_GET_MY_LOCATION_BY_INT_COMPANY_ID_ALLOWED_KIOSK_AUTH_MODES` List the kiosk authentication modes allowed for locations in the specified Deputy company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_id` | integer | Yes | Deputy company ID whose allowed kiosk authentication modes should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Location By Coordinates **Slug:** `DEPUTY_GET_MY_LOCATION_GEO_BY_LATITUDE_BY_LONGITUDE` Get Deputy location data for the specified latitude and longitude. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `latitude` | string | Yes | Documented Deputy path parameter latitude. | | `longitude` | string | Yes | Documented Deputy path parameter longitude. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Flagged Location By Coordinates **Slug:** `DEPUTY_GET_MY_LOCATION_GEO_BY_LATITUDE_BY_LONGITUDE_FLAG_BY_FLAG` Get Deputy location data for the supplied coordinates using the specified location lookup flag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `latitude` | string | Yes | Documented Deputy path parameter latitude. | | `longitude` | string | Yes | Documented Deputy path parameter longitude. | | `location_flag` | string | Yes | Deputy location lookup flag that controls the coordinate result. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Memos **Slug:** `DEPUTY_GET_MY_MEMO` List memos available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Memo **Slug:** `DEPUTY_GET_MY_MEMO_BY_ID` Get a Deputy memo by its memo ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `memo_id` | integer | Yes | Numeric Deputy memo ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Memos **Slug:** `DEPUTY_GET_MY_MEMO_COMPANY_BY_ID` Get memos for a Deputy company by company ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_id` | string | Yes | Deputy company ID whose memos should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Memo Reactions **Slug:** `DEPUTY_GET_MY_MEMO_REACTIONS_BY_ORM_BY_REC_ID` Get reactions for the specified Deputy record type and record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Deputy record ID whose memo reactions should be returned. | | `record_type` | string | Yes | Deputy record type whose memo reactions should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Read Memos **Slug:** `DEPUTY_GET_MY_MEMO_READ` List memos marked as read for the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Memo Summary **Slug:** `DEPUTY_GET_MY_MEMO_SUMMARY` Get memo summary data for the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Team Memos **Slug:** `DEPUTY_GET_MY_MEMO_TEAM_BY_ID` Get memos for a Deputy team by team ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `team_id` | string | Yes | Deputy team ID whose memos should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Unread Memos **Slug:** `DEPUTY_GET_MY_MEMO_UNREAD` List unread memos for the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Memos **Slug:** `DEPUTY_GET_MY_MEMO_USER_BY_ID` Get memos for a Deputy user by user ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Deputy user ID whose memos should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Notifications **Slug:** `DEPUTY_GET_MY_NOTIFICATION` List notifications visible to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check My NPS Eligibility **Slug:** `DEPUTY_GET_MY_NPS_CANNPS` Return whether the connected Deputy user can submit an NPS response. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Photo **Slug:** `DEPUTY_GET_MY_PHOTO` Get the connected Deputy user's photo. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Preference **Slug:** `DEPUTY_GET_MY_PREF_BY_PREF_KEY` Get one preference for the connected Deputy user by its preference key. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pref_key` | string | Yes | Preference key to retrieve for the connected Deputy user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Roster Bids **Slug:** `DEPUTY_GET_MY_ROSTER_BIDS` List roster bids available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Roster **Slug:** `DEPUTY_GET_MY_ROSTER_BY_ID` Get one roster record available to the connected Deputy user by roster ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_id` | integer | Yes | Numeric Deputy roster ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Roster Offer Recommendation **Slug:** `DEPUTY_GET_MY_ROSTER_BY_ID_OFFER_GETRECOMMENDATION` Get the offer recommendation for a roster by roster ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_id` | integer | Yes | Numeric Deputy roster ID whose offer recommendation should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Roster Offer Status **Slug:** `DEPUTY_GET_MY_ROSTER_BY_ID_OFFER_STATUS` Get the offer status for a roster by roster ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_id` | integer | Yes | Numeric Deputy roster ID whose offer status should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Roster By Date Range **Slug:** `DEPUTY_GET_MY_ROSTER_BY_START_DATE_BY_END_DATE` Get the connected user's roster records between the specified start and end dates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end_date` | string | Yes | Documented Deputy path parameter endDate. | | `start_date` | string | Yes | Documented Deputy path parameter startDate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Open Rosters **Slug:** `DEPUTY_GET_MY_ROSTER_OPEN` List open roster records available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Open Rosters By Date Range **Slug:** `DEPUTY_GET_MY_ROSTER_OPEN_BY_START_DATE_BY_END_DATE_BY_MAX_WAIT_TIME` Get open roster data between the supplied dates, waiting up to the specified maximum wait time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end_date` | string | Yes | Documented Deputy path parameter endDate. | | `start_date` | string | Yes | Documented Deputy path parameter startDate. | | `max_wait_time` | string | Yes | Documented Deputy path parameter maxWaitTime. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Roster Publish Allowance **Slug:** `DEPUTY_GET_MY_ROSTER_PUBLISH_ALLOW_BY_NUM_OF_ROSTERS_TO_PUBLISH` Return whether the connected user may publish the specified number of rosters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `num_of_rosters_to_publish` | string | Yes | Documented Deputy path parameter numOfRostersToPublish. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Roster Publish Count **Slug:** `DEPUTY_GET_MY_ROSTER_PUBLISH_COUNT` Return the publish-related roster count for the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Rosters From Timestamp **Slug:** `DEPUTY_GET_MY_ROSTER_START_TIMESTAMP_BY_START_TIMESTAMP_REVERSE_BY_REVERSE_LIMIT_BY_LIMIT` List the connected user's roster records from a start timestamp using the specified ordering direction and result limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | Yes | Maximum number of roster records to return. | | `reverse` | boolean | Yes | Set true to return roster records in reverse order; false for forward order. | | `start_timestamp` | integer | Yes | Documented Deputy path parameter startTimestamp. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Setup Apps **Slug:** `DEPUTY_GET_MY_SETUP_APPS` Get Deputy setup app configuration available to the connected user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Gamingfy Setup **Slug:** `DEPUTY_GET_MY_SETUP_GAMINGFY_BY_ACTION` Get Gamingfy setup data for the selected list or decline operation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `gamingfy_operation` | string ("list" | "decline") | Yes | Gamingfy operation whose result should be returned: list or decline. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List States And Countries **Slug:** `DEPUTY_GET_MY_SETUP_GET_STATE_COUNTRY_LIST` List Deputy's supported countries and their states for setup and address selection. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Support Access **Slug:** `DEPUTY_GET_MY_SETUP_SUPPORT_ACCESS` Get Deputy support-access status or configuration for the connected user's account. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Tasks **Slug:** `DEPUTY_GET_MY_TASK` List tasks available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Completed Tasks **Slug:** `DEPUTY_GET_MY_TASK_COMPLETED` List completed tasks available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Department Tasks **Slug:** `DEPUTY_GET_MY_TASK_DEPARTMENT` Get department-related task data available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Department Tasks By Date **Slug:** `DEPUTY_GET_MY_TASK_DEPARTMENT_BY_DATE` Get department-related task data for the connected Deputy user on the supplied date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Date selecting the department-task data to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Timesheet Approval Allowance **Slug:** `DEPUTY_GET_MY_TIMESHEET_APPROVE_ALLOW_BY_NUM_OF_TIMESHEETS_TO_APPROVE` Return the approval-allowance result for the requested number of timesheets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `num_of_timesheets_to_approve` | string | Yes | Documented Deputy path parameter numOfTimesheetsToApprove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Timesheets By Range **Slug:** `DEPUTY_GET_MY_TIMESHEET_BY_START_BY_END` List the connected user's timesheets between the specified start and end values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end` | string | Yes | Documented Deputy path parameter end. | | `start` | string | Yes | Documented Deputy path parameter start. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Timesheets From Timestamp **Slug:** `DEPUTY_GET_MY_TIMESHEET_START_TIMESTAMP_BY_START_TIMESTAMP_REVERSE_BY_REVERSE_LIMIT_BY_LIMIT` List the connected user's timesheets from a start timestamp using the specified ordering direction and result limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | string | Yes | Maximum number of timesheets to return. | | `reverse` | string | Yes | Provider-defined ordering direction for the returned timesheets. | | `start_timestamp` | string | Yes | Start timestamp from which to return the connected user's timesheets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My To-Do Items **Slug:** `DEPUTY_GET_MY_TODO` List to-do items assigned to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Tokens **Slug:** `DEPUTY_GET_MY_TOKEN` List Deputy token records available to the connected user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Training Records **Slug:** `DEPUTY_GET_MY_TRAINING` List training records available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List My Unavailability By Date Range **Slug:** `DEPUTY_GET_MY_UNAVAIL_BY_START_DATE_BY_END_DATE` List the connected Deputy user's unavailability records between the specified start and end dates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end_date` | string | Yes | Documented Deputy path parameter endDate. | | `start_date` | string | Yes | Documented Deputy path parameter startDate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Widget Information **Slug:** `DEPUTY_GET_MY_WIDGET_INFO` Get Deputy widget metadata available to the connected user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get My Widget Run Data **Slug:** `DEPUTY_GET_MY_WIDGET_RUN` Get run-related widget data available to the connected Deputy user. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Widget Run **Slug:** `DEPUTY_GET_MY_WIDGET_RUN_BY_WIDGET_ID` Get run information for the specified Deputy widget ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `widget_id` | string | Yes | Deputy widget ID whose run information should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get resource record at time **Slug:** `DEPUTY_GET_RESOURCE_AT_TIME` Get one Deputy resource record as it existed at the specified Unix timestamp. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | integer | Yes | Numeric Deputy resource record ID. | | `timestamp` | integer | Yes | Historical point in time as Unix epoch seconds. | | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get resource field metadata **Slug:** `DEPUTY_GET_RESOURCE_FIELD_METADATA` Get Deputy's field metadata for the selected resource type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource collection to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get resource history **Slug:** `DEPUTY_GET_RESOURCE_HISTORY` Get the change history for one Deputy resource record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | integer | Yes | Numeric Deputy resource record ID. | | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get resource record **Slug:** `DEPUTY_GET_RESOURCE_RECORD` Get one Company, Employee, Leave, OperationalUnit, Roster, or Timesheet record by its numeric ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | integer | Yes | Numeric Deputy resource record ID. | | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Roster Recommendation **Slug:** `DEPUTY_GET_ROSTER_RECOMMENDATION` Get a roster recommendation for the connected employee or supervised employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `roster_id` | integer | Yes | Numeric Deputy roster ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Roster Swap Details **Slug:** `DEPUTY_GET_ROSTER_SWAP_DETAILS` Get swap details for a roster belonging to the connected employee or supervised employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `roster_id` | integer | Yes | Numeric Deputy roster ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bulk Location Settings Job Result **Slug:** `DEPUTY_GET_SUPERVISE_COMPANY_BULK_SETTINGS_CHECK_BY_JOB_ID` Get the check result for a Deputy bulk company-settings job by job ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Deputy bulk company-settings job ID returned when the update was started. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Location Settings **Slug:** `DEPUTY_GET_SUPERVISE_COMPANY_BY_ID_SETTINGS` Get the configured settings for a Deputy company or location by company ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Simplified Locations **Slug:** `DEPUTY_GET_SUPERVISE_COMPANY_SIMPLE` Get Deputy's simplified location list for lightweight location selection. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Timezone **Slug:** `DEPUTY_GET_SUPERVISE_COMPANY_TIMEZONE` Get the timezone configured for the connected user's Deputy company. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Department **Slug:** `DEPUTY_GET_SUPERVISE_DEPARTMENT_CHECK_BY_ID` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Department Location **Slug:** `DEPUTY_GET_SUPERVISE_DEPARTMENT_LOCATION_BY_ID` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Supervised Employees **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE` Get full Deputy records for all employees visible to the connected supervisor. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID` Get the Deputy employee record with the specified employee ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Numeric Deputy employee ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Related Resource Data **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_BY_ACTION` Get data for the specified employee-related resource category through Deputy's generic legacy route. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | | `resource_type` | string | Yes | Documented employee-related resource category whose data should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Contracted Hours **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_CONTRACTEDHOURS` Get contracted-hours information for the specified Deputy employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee HR Onboarding **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_ONBOARDING` Get HR onboarding information for the specified Deputy employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Payroll Connection **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_PAYROLL_CONNECTED` Read payroll connection information for the specified Deputy employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Payroll Sync Information **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_PAYROLL_SYNC` Read payroll synchronization information for the specified employee without starting a sync. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Login Management State **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_MANAGE_LOGIN` Read login-management information for the specified employee without changing login access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Validation Result **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_VALIDATE` Get Deputy's read-only validation result for the specified employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Contracted-Hours Templates **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATE` List the contracted-hours templates available for supervised employees. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Demo Data **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_DEMO` Get the employee demo result exposed by Deputy's legacy supervisor API. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Invitation Information **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_INVITATION` Get the invitation information returned by Deputy's zero-input employee invitation endpoint. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Real Employee Records **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_REAL` Get the employee subset Deputy's legacy API classifies as real employees. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count Real Employees **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_REAL_COUNT` Return the count of employees Deputy's legacy API classifies as real employees. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Role Management Data **Slug:** `DEPUTY_GET_SUPERVISE_EMPLOYEE_ROLE_MANAGE` Read the employee-role management data exposed by Deputy; this operation does not change roles. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Shift Information **Slug:** `DEPUTY_GET_SUPERVISE_EMPSHIFTINFO_BY_INT_EMP_ID_BY_BLN_ALL_COMPANY` Get current shift information for an employee, optionally broadened across all companies by the required scope flag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Numeric Deputy employee ID whose current shift status should be returned. | | `include_all_companies` | string ("true" | "false") | Yes | Use true to include shift information across all companies, or false to limit the result. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Roster Recommendation Status **Slug:** `DEPUTY_GET_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_ID_STATUS` Get the current recommendation status for a Deputy roster by roster ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_id` | integer | Yes | Numeric Deputy roster ID whose recommendation status should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Leave Information **Slug:** `DEPUTY_GET_SUPERVISE_LEAVE_BY_INT_EMPLOYEE_ID` Get Deputy leave information for the specified employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Numeric Deputy employee ID whose leave information should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Leave Setup Information **Slug:** `DEPUTY_GET_SUPERVISE_LEAVE_BY_INT_EMPLOYEE_ID_BY_STR_SETUP` Get leave information for an employee using Deputy's required leave setup selector. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `setup` | string | Yes | Deputy leave setup selector used to choose the requested leave representation. | | `employee_id` | integer | Yes | Numeric Deputy employee ID whose leave setup information should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recent Rosters **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER` List Deputy rosters from the previous 12 hours through the next 36 hours. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Rosters by Date **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_BY_DATE` Get Deputy roster data for the specified date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Roster date in Deputy's documented date representation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Rosters by Date **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_BY_DATE_BY_INT_COMPANY_ID` Get roster data for a Deputy company on the specified date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Documented Deputy path parameter date. | | `company_id` | string | Yes | Deputy company or location ID whose roster data should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Company Rosters by Date **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_BY_DATE_BY_INT_COMPANY_ID_BY_LIMIT_BY_OFFSET_BY_FETCH_OPEN` Get a paginated roster result for a Deputy company and date, with an explicit selector for including open rosters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Documented Deputy path parameter date. | | `limit` | string | Yes | Maximum number of roster records requested from Deputy. | | `offset` | string | Yes | Number of matching roster records to skip. | | `company_id` | string | Yes | Deputy company or location ID whose roster data should be returned. | | `include_open` | string | Yes | Deputy fetch-open selector controlling whether open roster records are included. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Roster Bids **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_BY_ID_BIDS` Get bids for a roster by roster ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Roster Autobuild Job Result **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_CHECKAUTOBUILD_BY_JOB_KEY` Get the status or result of an automatic Deputy roster-build job by job key. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_key` | string | Yes | Deputy automatic roster-build job key returned when the job was started. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Roster Autofill Job Result **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_CHECKAUTOFILL_BY_JOB_KEY` Get the status or result of an automatic Deputy roster-fill job by job key. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_key` | string | Yes | Deputy automatic roster-fill job key returned when the job was started. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Roster Manager Notification Information **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_NOTIFYMANAGER_BY_ID` Get Deputy's manager-notification information for the specified roster; this GET operation does not send a notification. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pending Roster Swap Approval Details **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_PENDING_APPROVAL_SWAP_DETAILS_BY_ID` Get pending-approval swap details for a roster by roster ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Roster System Templates **Slug:** `DEPUTY_GET_SUPERVISE_ROSTER_SYSTEMTEMPLATE_LIST_BY_INT_MODE` List Deputy roster system templates using the required provider-defined numeric mode. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | integer | Yes | Deputy numeric mode selecting which roster system templates are returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bulk Timesheet Job Result **Slug:** `DEPUTY_GET_SUPERVISE_TIMESHEET_BULK_CHECK_BY_JOB_ID` Get the check result for a Deputy bulk timesheet job by job ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Deputy bulk timesheet job ID returned when the job was started. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Timesheet by Date **Slug:** `DEPUTY_GET_SUPERVISE_TIMESHEET_BY_EMPLOYEE_ID_BY_DATE` Get Deputy timesheet information for an employee on the specified date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Documented Deputy path parameter date. | | `employee_id` | string | Yes | Deputy employee ID whose timesheet information should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Employee Unavailability **Slug:** `DEPUTY_GET_SUPERVISE_UNAVAIL_BY_INT_EMPLOYEE_ID` Get Deputy unavailability information for the specified employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Numeric Deputy employee ID whose unavailability should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timesheet Details **Slug:** `DEPUTY_GET_TIMESHEET_DETAILS` Get detailed timesheet data for the connected employee or supervised employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `timesheet_id` | integer | Yes | Numeric Deputy timesheet ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timesheet History **Slug:** `DEPUTY_GET_TIMESHEET_HISTORY` Get timesheet change history for the connected employee or supervised employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `timesheet_id` | integer | Yes | Numeric Deputy timesheet ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timesheet Setup **Slug:** `DEPUTY_GET_TIMESHEET_SETUP` Get timesheet setup information for the connected employee or supervised employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `timesheet_id` | integer | Yes | Numeric Deputy timesheet ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Companies and Locations **Slug:** `DEPUTY_LIST_COMPANIES` List Deputy companies, workplaces, and payroll entities, or return one company when company_id is provided. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_id` | integer | No | Numeric Deputy company or workplace ID. When set, return only that record. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Company Roster Templates **Slug:** `DEPUTY_LIST_COMPANY_ROSTER_TEMPLATES` List roster templates for a Deputy company without changing them. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Provider request object for this operation. | | `company_id` | string | Yes | Deputy company ID whose roster templates to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Employees **Slug:** `DEPUTY_LIST_EMPLOYEES` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor from a previous response. Omit for the first page. | | `search` | object | No | 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. | | `page_size` | integer | No | Maximum employees in this page (1-500). | | `employee_id` | integer | No | Numeric Deputy employee ID. When set, return only that employee. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Gamingfy Items **Slug:** `DEPUTY_LIST_GAMINGFY_ITEMS` List Gamingfy setup items without changing their state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Provider request object for this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Leave Records **Slug:** `DEPUTY_LIST_LEAVE` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search. | | `search` | object | No | 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. | | `leave_id` | integer | No | Numeric Deputy leave ID. When set, return only that leave record. | | `page_size` | integer | No | Maximum leave records in this page (1-500). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Operational Units **Slug:** `DEPUTY_LIST_OPERATIONAL_UNITS` Return one page of Deputy operational units (areas or departments), or one unit when operational_unit_id is provided. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search. | | `search` | object | No | Deputy QueryRequest search expression used to filter records. Use documented resource field names and Deputy query operators; omit to list all visible records. | | `page_size` | integer | No | Maximum records in this page. Must be between 1 and 500. | | `operational_unit_id` | integer | No | Numeric Deputy operational unit ID. When set, return that record instead of a list page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List resource comments **Slug:** `DEPUTY_LIST_RESOURCE_COMMENTS` List comments attached to one Deputy resource record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | integer | Yes | Numeric Deputy resource record ID. | | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List resource records **Slug:** `DEPUTY_LIST_RESOURCE_RECORDS` List raw Company, Employee, Leave, OperationalUnit, Roster, or Timesheet records. Use the curated list tools when their safer reduced fields are sufficient. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource collection to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Roster Shifts **Slug:** `DEPUTY_LIST_ROSTER_SHIFTS` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search. | | `search` | object | No | 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. | | `page_size` | integer | No | Maximum roster shifts in this page. Must be between 1 and 500. | | `roster_id` | integer | No | Numeric Deputy roster ID. When set, return that record instead of a list page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Roster Swaps **Slug:** `DEPUTY_LIST_ROSTER_SWAPS` List roster swaps in a date range for the connected employee or supervised employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `end_date` | string | Yes | End date for the roster-swap range. | | `start_date` | string | Yes | Start date for the roster-swap range. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Timesheets **Slug:** `DEPUTY_LIST_TIMESHEETS` Return one page of worked-time records, or one timesheet when 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor from a previous response. Omit for the first page and pass it back unchanged to continue the same search. | | `search` | object | No | Deputy QueryRequest search expression used to filter records. Use documented Timesheet resource field names and Deputy query operators; omit to list all visible records. | | `page_size` | integer | No | Maximum records in this page. Must be between 1 and 500. | | `timesheet_id` | integer | No | Numeric Deputy timesheet ID. When set, return that record instead of a list page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search My Colleagues **Slug:** `DEPUTY_POST_MY_COLLEAGUE_QUERY` Search colleague records visible to the connected Deputy user using a Deputy query object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or update Contactaddress **Slug:** `DEPUTY_POST_MY_CONTACTADDRESS` Create or update contact-address data for the connected Deputy user. Verify the request values before saving it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | JSON object documented for POST /v1/my/contactaddress. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_contactaddress__post. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Emergency Contact Address **Slug:** `DEPUTY_POST_MY_CONTACTADDRESS_EMERGENCY` Update emergency contact information for the connected Deputy user. Verify the request values before updating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Locations Pending Approval **Slug:** `DEPUTY_POST_MY_LOCATION_PENDING_APPROVAL_QUERY` Query locations awaiting approval for the connected Deputy user using a Deputy query object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Memo Feed **Slug:** `DEPUTY_POST_MY_MEMO` Apply 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Provider-defined JSON object for POST /v1/my/memo. Deputy does not document its fields; this is not the memo-creation route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add My Memo Comment **Slug:** `DEPUTY_POST_MY_MEMO_BY_ID_COMMENT` Add a comment to the specified memo for the connected user. Verify the memo ID and comment content before creating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `memo_id` | integer | Yes | Numeric Deputy memo ID to comment on. | | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Company Memo **Slug:** `DEPUTY_POST_MY_MEMO_COMPANY_BY_ID` Apply the supplied memo change for the specified Deputy company. Verify the company ID and request values before updating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `company_id` | string | Yes | Deputy company ID targeted by the memo operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Memo Summary **Slug:** `DEPUTY_POST_MY_MEMO_SUMMARY` Update memo summary state for the connected Deputy user using the supplied request values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Team Memo **Slug:** `DEPUTY_POST_MY_MEMO_TEAM_BY_ID` Apply the supplied memo change for the specified Deputy team. Verify the team ID and request values before updating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `team_id` | string | Yes | Deputy team ID targeted by the memo operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update User Memo **Slug:** `DEPUTY_POST_MY_MEMO_USER_BY_ID` Apply the supplied memo change for the specified Deputy user. Verify the user ID and request values before updating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `user_id` | string | Yes | Deputy user ID targeted by the memo operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or update Nps **Slug:** `DEPUTY_POST_MY_NPS` Create or update the connected Deputy user's Net Promoter Score response. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | JSON object documented for POST /v1/my/nps. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_nps__post. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Postpone My NPS Response **Slug:** `DEPUTY_POST_MY_NPS_LATER` Postpone the connected Deputy user's NPS response or prompt. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Photo **Slug:** `DEPUTY_POST_MY_PHOTO_BY_NAME` Update the connected Deputy user's named photo using the supplied photo request body. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `photo_name` | string | Yes | Provider-defined name identifying the connected user's photo. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Preference **Slug:** `DEPUTY_POST_MY_PREF_BY_PREF_KEY` Update the connected Deputy user's named preference using the supplied preference value. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `pref_key` | string | Yes | Preference key to update for the connected Deputy user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Support Access **Slug:** `DEPUTY_POST_MY_PREF_UPDATE_SUPPORT_ACCESS` Change Deputy support access for the connected user's account using the supplied support-access setting. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request My Roster Bid **Slug:** `DEPUTY_POST_MY_ROSTER_BIDS_REQUEST` Create pending bids for the connected employee on eligible published open rosters that require approval. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_ids` | array | Yes | Published open roster IDs that require approval and are eligible for the connected employee. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Withdraw My Roster Bid **Slug:** `DEPUTY_POST_MY_ROSTER_BIDS_WITHDRAW` Change the connected employee's pending bids on the specified rosters to withdrawn. Verify the roster IDs before updating them. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_ids` | array | Yes | Roster IDs with pending bids belonging to the connected employee. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Offer My Roster **Slug:** `DEPUTY_POST_MY_ROSTER_BY_ID_OFFER` Create an offer for the specified roster record using the supplied offer details. Verify the roster ID before updating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `roster_id` | integer | Yes | Numeric Deputy roster ID to offer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel My Roster Offer **Slug:** `DEPUTY_POST_MY_ROSTER_BY_ID_OFFER_CANCEL` Cancel the existing offer for the specified roster record. Verify the roster ID before updating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `roster_id` | integer | Yes | Numeric Deputy roster ID whose offer should be cancelled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Roster Swap **Slug:** `DEPUTY_POST_MY_ROSTER_BY_ID_SWAP_BY_ACTION` Request, cancel, accept, recommend, decline, or decline all for the specified roster swap. Verify the roster ID and selected operation before updating it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `roster_id` | integer | Yes | Numeric Deputy roster ID whose swap state should be changed. | | `swap_action` | string ("request" | "cancel" | "accept" | "recommendation" | "decline" | "declineall") | Yes | Roster-swap operation to apply: request, cancel, accept, recommendation, decline, or declineall. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Claim My Open Rosters **Slug:** `DEPUTY_POST_MY_ROSTER_OPEN` Assign 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_ids` | array | Yes | Published open roster IDs that do not require approval and are eligible for the connected employee. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Workplace **Slug:** `DEPUTY_POST_MY_SETUP_ADD_NEW_WORKPLACE` Create a new workplace in the connected Deputy account using the supplied workplace details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve Address And Timezone From Coordinates **Slug:** `DEPUTY_POST_MY_SETUP_GET_ADDRESS_TIMEZONE_FROM_GEO` Resolve an address and timezone from the supplied geographic coordinates without changing Deputy data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `latitude` | number | Yes | Latitude to resolve, sent to Deputy as lat. | | `longitude` | number | Yes | Longitude to resolve, sent to Deputy as lon. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve Coordinates And Timezone From Address **Slug:** `DEPUTY_POST_MY_SETUP_GET_GEO_TIMEZONE_FROM_ADDRESS` Resolve geographic coordinates and a timezone from the supplied address without changing Deputy data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Email To Customer Experience **Slug:** `DEPUTY_POST_MY_SETUP_SEND_EMAIL_TO_CX` Immediately send the supplied email to Deputy Customer Experience. Email delivery is external and cannot be undone. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Run My Setup SF Operation **Slug:** `DEPUTY_POST_MY_SETUP_SF` Submit 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Workplace **Slug:** `DEPUTY_POST_MY_SETUP_VALIDATE_WORKPLACE` Validate the supplied Deputy workplace details and return the result without changing the workplace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Task State **Slug:** `DEPUTY_POST_MY_TASK` Apply 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Provider-defined JSON object for POST /v1/my/task. Deputy does not document its fields; this is not the task-creation route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Task **Slug:** `DEPUTY_POST_MY_TASK_BY_ID` Update the specified task for the connected Deputy user using the supplied request values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `task_id` | integer | Yes | Numeric Deputy task ID to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Completed Tasks **Slug:** `DEPUTY_POST_MY_TASK_COMPLETED` Apply the supplied completion change to tasks for the connected Deputy user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Department Tasks **Slug:** `DEPUTY_POST_MY_TASK_DEPARTMENT` Apply the supplied department-task change for the connected Deputy user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update My Department Tasks By Date **Slug:** `DEPUTY_POST_MY_TASK_DEPARTMENT_BY_DATE` Apply the supplied department-task change for the connected Deputy user on the specified date. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Date selecting the department-task records to change. | | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or update Todo **Slug:** `DEPUTY_POST_MY_TODO` Create or update a to-do item for the connected Deputy user. Verify the request values before saving it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | JSON object documented for POST /v1/my/todo. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_todo__post. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or update Unavail **Slug:** `DEPUTY_POST_MY_UNAVAIL` Create or update an unavailability record for the connected Deputy user. Verify the request values before saving it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | JSON object documented for POST /v1/my/unavail. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_unavail__post. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Settings for All Locations **Slug:** `DEPUTY_POST_SUPERVISE_COMPANY_ALL_SETTINGS` Update the supplied Deputy location settings across all locations. Verify the setting names and values before applying the broad change. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `week_start` | integer | No | Deputy weekday number to set as the start of the week for all locations. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Location **Slug:** `DEPUTY_POST_SUPERVISE_COMPANY_BY_ID` Update documented fields for a Deputy company or location by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Numeric Deputy company or location ID to update. | | `address` | string | No | Replacement address or place description. | | `timezone` | string | No | Replacement IANA timezone. | | `is_workplace` | integer | No | Deputy integer flag indicating whether the location is a workplace. | | `address_notes` | string | No | Replacement notes supplementing the address. | | `workplace_code` | string | No | Replacement short workplace code. | | `workplace_name` | string | No | Replacement workplace or location name. | | `is_payroll_entity` | integer | No | Deputy integer flag indicating whether the location is a payroll entity. | | `parent_company_id` | integer | No | Replacement parent Deputy company ID. | | `payroll_export_code` | string | No | Replacement payroll export code. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Archive Location **Slug:** `DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_ARCHIVE` Archive the selected Deputy company or location so it is no longer active; verify the company ID before running. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cascade Location Settings **Slug:** `DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_CASCADE_SETTINGS` Update documented settings for a Deputy company and cascade those values to eligible child records. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Location **Slug:** `DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_DELETE` Permanently delete the Deputy company or location identified by company ID; verify the target before running. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Location Google Place ID **Slug:** `DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_GOOGLE_PLACE_ID_BY_GOOGLE_PLACE_ID` Set or replace the Google Place ID associated with a Deputy company or location. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Documented Deputy path parameter id. | | `payload` | object | Yes | 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. | | `google_place_id` | string | Yes | Google Place ID to associate with the Deputy company or location. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Location Settings **Slug:** `DEPUTY_POST_SUPERVISE_COMPANY_BY_ID_SETTINGS` Update documented settings for one Deputy company or location by company ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Documented Deputy path parameter id. | | `week_start` | integer | No | Deputy weekday number to set as the start of the week for this location. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Departments for Location **Slug:** `DEPUTY_POST_SUPERVISE_DEPARTMENT_ALL_BY_LOCATION_ID` Update the collection of department records associated with the specified Deputy location and return Deputy's untyped result object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `location_id` | integer | Yes | Numeric Deputy location ID whose departments are targeted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Department **Slug:** `DEPUTY_POST_SUPERVISE_DEPARTMENT_BY_ID` Update a Deputy department's location, name, address, payroll export name, display order, or area type by department ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | integer | Yes | Numeric Deputy department or operational-unit ID to update. | | `address` | string | No | Replacement department address. | | `company_id` | integer | Yes | Destination Deputy location or company ID. | | `sort_order` | integer | No | Replacement department display order. | | `export_name` | string | No | Replacement payroll export name. | | `department_name` | string | Yes | Replacement department or area name. | | `department_type` | integer | No | Department type: 0 for a default area or 1 for a geo-based area. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Employee **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE` Create a Deputy employee using the supplied name, location, and optional employment details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `gender` | integer ("0" | "1" | "2" | "3") | No | Gender code: 0 prefer not to say, 1 male, 2 female, or 3 non-binary. | | `last_name` | string | Yes | Employee last name. | | `company_id` | integer | Yes | Deputy location ID to which the employee should be added. | | `first_name` | string | Yes | Employee first name. | | `payroll_id` | string | No | Optional payroll identifier for the employee. | | `start_date` | string | No | Employee start date in YYYY-MM-DD format. | | `country_code` | string | No | Country code for the employee's address. | | `mobile_phone` | string | No | Employee mobile phone number. | | `weekday_rate` | integer | No | Optional weekday pay rate accepted by Deputy. | | `date_of_birth` | string | No | Employee date of birth in Deputy's documented representation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Amend Employee ABP Data **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_AMEND_ABP` Update 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Employee **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID` Update documented fields for an existing Deputy employee by employee ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone` | string | Yes | Replacement phone value documented by Deputy for this employee update. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reactivate Employee **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_ACTIVATE` Reactivate a terminated Deputy employee, returning the employee to active status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Employee Related Resource **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_BY_ACTION` Apply the supplied object to the selected employee-related category: memo, roster, timesheet, journal, leave, or employee availability. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action` | string ("Memo" | "Roster" | "Timesheet" | "Journal" | "Leave" | "EmployeeAvailability") | Yes | Employee-related resource category to mutate: Memo, Roster, Timesheet, Journal, Leave, or EmployeeAvailability. | | `payload` | object | Yes | JSON object documented for POST /v1/supervise/employee/{employeeId}/{action}. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__employeeid_action_post. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Employee Contracted Hours **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_CONTRACTEDHOURS` Apply Deputy's documented contracted-hours mutation to an existing employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Employee Account **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_DELETE` Permanently delete the selected employee's Deputy account; unlike termination, this removes the account record and cannot be undone. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Employee HR Onboarding **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_ONBOARDING` Assign an HR onboarding record ID to the specified Deputy employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | | `onboarding_id` | string | Yes | HR onboarding record ID to assign. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Synchronize Employee Payroll Data **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_HR_PAYROLL_SYNC` Run Deputy's documented HR payroll synchronization operation for the specified employee; verify payroll inputs before running. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Invite Employee to Deputy **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_INVITE` Invite 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Employee Photo **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_PHOTO` Update the selected employee's photo using Deputy's documented photo object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Employee Two-Factor Authentication **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_RESET_2FA` Reset the selected employee's two-factor authentication, invalidating the current second-factor setup so it must be configured again. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Employee Login Communication **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SENDLOGIN` Send 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Employee Account Reset **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SEND_RESET_ACCOUNT` Send the selected employee Deputy's account-reset communication; this security-sensitive external message cannot be recalled. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Employee Award from Library **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SET_AWARD_FROM_LIBRARY` Apply 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `award_code` | string | Yes | Deputy library award code to apply. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | | `country_code` | string | Yes | Country code used to select an award from Deputy's award library. | | `agreement_ids` | array | No | Employment agreement record IDs to update. Omit to update all agreements for the employee. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Employee Award from Template **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_SET_AWARD_FROM_TEMPLATE` Apply a proven Deputy award contract template to selected employee agreements. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `contract_id` | integer | Yes | Deputy award contract template ID to apply. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | | `agreement_ids` | array | No | Employment agreement record IDs to update. Omit to update all agreements for the employee. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Terminate Employee **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_TERMINATE` Terminate the specified Deputy employee. This changes employment status but is distinct from deleting the employee account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Contracted-Hours Template **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATE` Apply Deputy's documented mutation to a contracted-hours template using the supplied template object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Contracted-Hours Template **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATE_BY_TEMPLATE_ID` Update a Deputy contracted-hours template by template ID using the supplied documented fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `template_id` | integer | Yes | Documented Deputy path parameter templateId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Employee **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_CREATE` Create one or more Deputy employees with each employee's first name, last name, and location ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employees` | array | Yes | One or more employees to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Process Employee Invitation **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_INVITATION` Process an employee invitation using Deputy's documented invitation payload; use validation first when the payload is untrusted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Supervised Employees **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_QUERY` Search supervised employees using Deputy's employee query filters and return matching employee records. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Employee Gender Data **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_RESET_GENDER` Reset employee gender data using Deputy's documented reset object; verify the target data before running. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Employee Data **Slug:** `DEPUTY_POST_SUPERVISE_EMPLOYEE_VALIDATE` Validate employee data before creating or updating an employee; this check does not change workforce records. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Roster Recommendations **Slug:** `DEPUTY_POST_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_ID` Update employee recommendations for the specified roster using the supplied object and return Deputy's untyped result object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `roster_id` | integer | Yes | Numeric Deputy roster ID whose recommendations should be changed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Notify Recommended Employee **Slug:** `DEPUTY_POST_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_ID_NOTIFY` Send an immediate, non-recallable workforce notification to the selected recommended employee for a roster; verify the roster and notification details first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Required notification payload documented by Deputy for the selected roster recommendation. | | `roster_id` | integer | Yes | Roster ID whose recommended employee should be notified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Notify All Recommended Employees **Slug:** `DEPUTY_POST_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_ID_NOTIFY_ALL_RECOMMENDED` Send immediate, non-recallable workforce notifications to every recommended employee for a roster; verify the roster and notification details first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Required notification payload documented by Deputy for all recommended employees. | | `roster_id` | integer | Yes | Roster ID whose recommended employees should all be notified. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Roster Recommendations **Slug:** `DEPUTY_POST_SUPERVISE_GETRECOMMENDATION_BY_INT_ROSTER_ID_RESET` Reset recommendations for a roster. This changes workforce recommendation state; verify the roster ID and payload before running it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Required reset payload documented by Deputy for the selected roster recommendation. | | `roster_id` | integer | Yes | Roster ID whose recommendations should be reset. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or Update Roster Timesheet Data **Slug:** `DEPUTY_POST_SUPERVISE_GET_ROSTER_TIMESHEET` Create or update Deputy's documented roster-timesheet record using the supplied relationship object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Manage Employee Leave **Slug:** `DEPUTY_POST_SUPERVISE_LEAVE_LEAVE_MANAGEMENT` Update leave-management state for the leave record or request identified in the supplied object and return Deputy's untyped result object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or Update Roster **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER` Create or update a Deputy roster using the supplied documented roster object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | JSON object documented for POST /v1/supervise/roster. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_roster__post. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Autobuild Roster **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_AUTOBUILD` Start an asynchronous job that creates unpublished Deputy shifts for selected areas and dates using staffing, coverage, or historical demand. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `base` | string ("RequiredStaff" | "MinimumCoverage" | "Historical") | Yes | Scheduling metric Deputy should use to generate shifts. | | `lengths` | array | Yes | Preferred shift lengths in hours, ordered by priority. | | `frequency` | number | Yes | Generated shift granularity in hours: 0.25, 0.5, or 1.0. | | `end_timestamp` | integer | Yes | Period end as a Unix timestamp in seconds. | | `start_timestamp` | integer | Yes | Period start as a Unix timestamp in seconds. | | `operational_unit_ids` | array | Yes | One or more area or operational-unit IDs in which to generate shifts. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Autobuild Roster from Agreed Hours **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_AUTOBUILDFROMAGREEDHOURS` Create Deputy shifts from selected employees' agreed-hours profiles for specified areas, locations, and dates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end_date` | string | Yes | Last schedule date in YYYY-MM-DD format. | | `start_date` | string | Yes | First schedule date in YYYY-MM-DD format. | | `company_ids` | array | Yes | One or more Deputy location or company IDs for the generated shifts. | | `employee_ids` | array | Yes | One or more employees whose agreed hours should become shifts. | | `operational_unit_ids` | array | Yes | One or more area or operational-unit IDs in which to create agreed-hours shifts. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Autobuild Roster from GFE **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_AUTOBUILDFROMGFE` Start Deputy's documented GFE-based automatic roster-build operation using the supplied inputs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Autofill Roster **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_AUTOFILL` Start an asynchronous job that assigns candidate employees to selected open Deputy shifts using bounded search and optimization settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `config` | object | Yes | Required optimization object; each cost, equality, and prior-match flag is optional. | | `roster_ids` | array | Yes | One or more open roster IDs to fill, up to 1000 shifts. | | `employee_ids` | array | Yes | One or more candidate Deputy employee IDs. | | `search_depth` | integer | Yes | Permutation search depth; larger values can take longer. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Roster Autofill **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_CANCELAUTOFILL` Cancel the roster autofill operation identified by the supplied Deputy cancellation object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Roster Autobuild from Agreed Hours **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_CHECKAUTOBUILDFROMAGREEDHOURS_BY_JOB_KEY` Check or advance Deputy's documented roster autobuild-from-agreed-hours job using its job key and request object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_key` | string | Yes | Deputy job key for the roster autobuild-from-agreed-hours operation. | | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check GFE Roster Autobuild **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_CHECKAUTOBUILDFROMGFE_BY_JOB_KEY` Check or advance Deputy's documented GFE-based roster-autobuild job using its job key and request object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_key` | string | Yes | Deputy job key for the GFE-based automatic roster-build operation. | | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Roster **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_COPY` Copy Deputy roster data using the supplied source and destination settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to_date` | string | Yes | Destination roster date in YYYY-MM-DD format. | | `from_date` | string | Yes | Source roster start date in YYYY-MM-DD format. | | `operational_unit_ids` | array | Yes | Deputy operational-unit IDs whose rosters should be copied. | | `require_error_details` | integer ("0" | "1") | No | Set to 1 to request detailed copy errors, or 0 otherwise. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Rosters in Batch **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_COPY_BATCH` Copy multiple rosters in one request using the supplied source and destination settings; verify every roster target before running. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Discard Roster Changes **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_DISCARD` Discard the Deputy roster state selected by the supplied documented object; verify the target before running. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `roster_ids` | array | Yes | Deputy roster record IDs to discard. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Publish Roster **Slug:** `DEPUTY_POST_SUPERVISE_ROSTER_PUBLISH` Publish the Deputy roster selected by the supplied publication object, making the schedule externally visible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | integer | Yes | Deputy roster publication mode. | | `roster_ids` | array | Yes | Deputy roster record IDs to publish. | | `all_locations` | integer ("0" | "1") | Yes | Set to 1 to publish rosters for all locations, or 0 to use the selected roster IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Recalculate Timesheets in Bulk **Slug:** `DEPUTY_POST_SUPERVISE_TIMESHEET_BULK_RECALCULATE` Recalculate the selected timesheets in bulk; verify the timesheet selection and recalculation inputs before updating them. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### End Employee Timesheet **Slug:** `DEPUTY_POST_SUPERVISE_TIMESHEET_END` Clock off an employee and end the selected active timesheet using Deputy's documented clock-off object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `timesheet_id` | integer | Yes | Numeric Deputy timesheet ID to stop. | | `meal_break_minutes` | integer | Yes | Number of meal-break minutes taken during the timesheet period. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Toggle Employee Timesheet Break **Slug:** `DEPUTY_POST_SUPERVISE_TIMESHEET_PAUSE` Toggle 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `timesheet_id` | integer | Yes | Numeric Deputy timesheet ID to pause or resume. | | `meal_break_minutes` | integer | Yes | Meal-break minutes supplied for the pause or resume transition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Start Employee Timesheet **Slug:** `DEPUTY_POST_SUPERVISE_TIMESHEET_START` Clock on an employee and start a timesheet using Deputy's documented clock-on object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_id` | integer | Yes | Numeric Deputy employee ID to clock on. | | `operational_unit_id` | integer | Yes | Deputy operational-unit or area ID for the timesheet. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit My NPS Response **Slug:** `DEPUTY_PUT_MY_NPS` Submit a Net Promoter Score response for the connected Deputy user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | JSON object documented for PUT /v1/my/nps. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/my_nps__put. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set My Preference **Slug:** `DEPUTY_PUT_MY_PREF_BY_PREF_KEY` Set the connected Deputy user's preference identified by key to the supplied value. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `pref_key` | string | Yes | Preference key to set for the connected Deputy user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Company **Slug:** `DEPUTY_PUT_SUPERVISE_COMPANY` Add a Deputy location with its workplace name, address, and optional workplace, timezone, parent-company, and payroll settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | Street address or place description for the location. | | `timezone` | string | No | Optional IANA timezone, such as Australia/Sydney. | | `is_workplace` | integer | No | Deputy integer flag indicating whether this location is a workplace. | | `address_notes` | string | No | Optional notes that supplement the address. | | `workplace_code` | string | No | Optional short workplace code. | | `workplace_name` | string | Yes | Name of the new Deputy workplace or location. | | `is_payroll_entity` | integer | No | Deputy integer flag indicating whether this location is a payroll entity. | | `parent_company_id` | integer | No | Optional parent Deputy company ID. | | `payroll_export_code` | string | No | Optional payroll export code for this location. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Department **Slug:** `DEPUTY_PUT_SUPERVISE_DEPARTMENT` Create a Deputy department from the supplied documented department fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | No | Optional address for the department or area. | | `company_id` | integer | No | Location ID to which the department belongs. | | `sort_order` | integer | No | Optional display order for the department. | | `export_name` | string | No | Optional payroll export name for the department. | | `location_id` | integer | No | Optional location ID for the department. | | `department_name` | string | Yes | Name of the Deputy department or area to create. | | `department_type` | integer | No | Deputy department type: 0 for default or 1 for a geo-based area. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Multiple Departments **Slug:** `DEPUTY_PUT_SUPERVISE_DEPARTMENT_CREATE` Create multiple Deputy departments from the supplied documented department data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `departments` | array | Yes | Departments to create in one request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Employee **Slug:** `DEPUTY_PUT_SUPERVISE_EMPLOYEE` Create a Deputy employee using the supplied documented employee fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | JSON object documented for PUT /v1/supervise/employee. Use only fields accepted by Deputy; see https://developer.deputy.com/reference/supervise_employee__put. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Replace Employee Contracted Hours **Slug:** `DEPUTY_PUT_SUPERVISE_EMPLOYEE_BY_EMPLOYEE_ID_CONTRACTEDHOURS` Update contracted-hours details for an existing Deputy employee by employee ID; verify the employee and effective hours before running. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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. | | `employee_id` | integer | Yes | Documented Deputy path parameter employeeId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Contracted-Hours Template **Slug:** `DEPUTY_PUT_SUPERVISE_EMPLOYEE_CONTRACTEDHOURS_TEMPLATE` Create a Deputy contracted-hours template using the supplied documented template object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Employee Data **Slug:** `DEPUTY_PUT_SUPERVISE_EMPLOYEE_VALIDATE` Validate the supplied employee object through Deputy's legacy PUT validation route and return the validation result. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Replace resource record **Slug:** `DEPUTY_REPLACE_RESOURCE_RECORD` Replace 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record` | string | Yes | Partial typed Deputy record changes. resource_type selects the matching endpoint and schema. | | `record_id` | integer | Yes | Numeric Deputy resource record ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Replace Unavailability **Slug:** `DEPUTY_REPLACE_UNAVAILABILITY` Replace a self or supervised employee unavailability record by ID. Verify the target and complete replacement object first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Complete replacement object documented by Deputy for the unavailability record. | | `audience` | string ("self" | "supervised") | Yes | Use self for the connected employee or supervised for employees they supervise. | | `unavailability_id` | string | Yes | Deputy unavailability record ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Save Company Roster Template **Slug:** `DEPUTY_SAVE_COMPANY_ROSTER_TEMPLATE` Save changes to roster-template data for a Deputy company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Provider request object for this operation. | | `company_id` | string | Yes | Deputy company ID whose roster templates to access. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search resource records **Slug:** `DEPUTY_SEARCH_RESOURCE_RECORDS` Search one Deputy resource type with typed filters, sorting, offset pagination, and optional related-record expansion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `join` | array | No | Related ORM names to expand inline, such as EmployeeObject. | | `sort` | object | No | Deputy field names mapped to asc or desc. | | `start` | integer | No | Zero-based result offset. | | `search` | object | No | Search clauses keyed by a stable label such as s1 or employee_filter. | | `max_results` | integer | No | Maximum records to return; Deputy caps this at 500. | | `resource_type` | string ("company" | "employee" | "leave" | "operational_unit" | "roster" | "timesheet") | Yes | Resource type to search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Employee Workplace Association **Slug:** `DEPUTY_SET_EMPLOYEE_WORKPLACE_ASSOCIATION` Associate an employee with a workplace or remove that relationship. Verify both IDs before changing it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `associated` | boolean | Yes | True to associate the employee with the workplace; false to remove the association. | | `employee_id` | integer | Yes | Numeric Deputy employee ID. | | `set_primary` | boolean | No | Whether to make the workplace primary when associating. | | `agreement_id` | integer | No | Agreement ID to assign when associating. Omit to create a new agreement. | | `workplace_id` | integer | Yes | Numeric Deputy workplace or location ID. | | `removal_payload` | object | No | Deputy request object required when removing an association. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Memo Read State **Slug:** `DEPUTY_SET_MEMO_READ_STATE` Mark a memo log read or unread for the connected Deputy user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `state` | string ("read" | "unread") | Yes | Desired memo-log read state. | | `memo_id` | integer | Yes | Numeric Deputy memo ID. | | `payload` | object | Yes | Request object required by Deputy for the memo read-state transition. | | `memo_log_id` | integer | Yes | Numeric memo-log ID whose read state to set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Task Completion **Slug:** `DEPUTY_SET_TASK_COMPLETION` Complete or restore a task belonging to the connected Deputy user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payload` | object | Yes | Request object required by Deputy for the task transition. | | `task_id` | integer | Yes | Numeric Deputy task ID. | | `completed` | boolean | Yes | True to perform the task's do transition; false to undo it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update resource record **Slug:** `DEPUTY_UPDATE_RESOURCE_RECORD` Update an existing Employee, Leave, OperationalUnit, Roster, or Timesheet record using Deputy's documented complete resource schema. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record` | string | Yes | Complete typed Deputy record. resource_type selects the matching endpoint and schema. | | `record_id` | integer | Yes | Numeric Deputy resource record ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |