Add Deputy to your AI agent

Invalidate the Deputy token identified by its documented token ID or token value. Verify the target before deleting it.

Permanently delete one comment from a Deputy resource record. Verify both IDs first.

Permanently delete an Employee, Leave, OperationalUnit, Roster, or Timesheet record by ID. Verify the resource type and record ID first.

Permanently delete the Deputy department identified by department ID.

Permanently delete an employee contracted-hours template by template ID.

Delete the employee invitation data selected by Deputy's zero-input invitation endpoint; deletion is irreversible.

Permanently delete a Deputy roster template by template ID.

Permanently delete a self or supervised employee unavailability record by ID.

Find the closest existing record matching a partial typed record before deciding whether to create or update it.

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.

Get current weather or weather for a specified date for one Deputy department.

Get current weather or weather for a specified date for locations in one Deputy company.

Get OAuth Identity.

List colleagues visible to the connected Deputy user.

Return the number of colleagues visible to the connected Deputy user.

List contact addresses available to the connected Deputy user.

List all contact addresses available to the connected Deputy user.

Get emergency contact addresses for the connected Deputy user.

Get contact addresses for employees subordinate to the connected Deputy user.

Get subordinate contact addresses for the specified Deputy company.

Get a Deputy department by its department ID.

Get feed records for the connected Deputy user over the supplied start-to-end interval.

Get feed records for the connected Deputy user on the specified date.

Get a summary of the connected Deputy user's feed over the supplied start-to-end interval.

Get leave data for the connected Deputy user using the specified setup selector.

List all locations available to the connected Deputy account.

Get location records for the specified Deputy company.

List the kiosk authentication modes allowed for locations in the specified Deputy company.

Get Deputy location data for the specified latitude and longitude.

Get Deputy location data for the supplied coordinates using the specified location lookup flag.

List memos available to the connected Deputy user.

Get a Deputy memo by its memo ID.

Get memos for a Deputy company by company ID.

Get reactions for the specified Deputy record type and record ID.

List memos marked as read for the connected Deputy user.

Get memo summary data for the connected Deputy user.

Get memos for a Deputy team by team ID.

List unread memos for the connected Deputy user.

Get memos for a Deputy user by user ID.

List notifications visible to the connected Deputy user.

Return whether the connected Deputy user can submit an NPS response.

Get the connected Deputy user's photo.

Get one preference for the connected Deputy user by its preference key.

List roster bids available to the connected Deputy user.

Get one roster record available to the connected Deputy user by roster ID.

Get the offer recommendation for a roster by roster ID.

Get the offer status for a roster by roster ID.

Get the connected user's roster records between the specified start and end dates.

List open roster records available to the connected Deputy user.

Get open roster data between the supplied dates, waiting up to the specified maximum wait time.

Return whether the connected user may publish the specified number of rosters.

Return the publish-related roster count for the connected Deputy user.

List the connected user's roster records from a start timestamp using the specified ordering direction and result limit.

Get Deputy setup app configuration available to the connected user.

Get Gamingfy setup data for the selected list or decline operation.

List Deputy's supported countries and their states for setup and address selection.

Get Deputy support-access status or configuration for the connected user's account.

List tasks available to the connected Deputy user.

List completed tasks available to the connected Deputy user.

Get department-related task data available to the connected Deputy user.

Get department-related task data for the connected Deputy user on the supplied date.

Return the approval-allowance result for the requested number of timesheets.

List the connected user's timesheets between the specified start and end values.

List the connected user's timesheets from a start timestamp using the specified ordering direction and result limit.

List to-do items assigned to the connected Deputy user.

List Deputy token records available to the connected user.

List training records available to the connected Deputy user.

List the connected Deputy user's unavailability records between the specified start and end dates.

Get Deputy widget metadata available to the connected user.

Get run-related widget data available to the connected Deputy user.

Get run information for the specified Deputy widget ID.

Get one Deputy resource record as it existed at the specified Unix timestamp.

Get Deputy's field metadata for the selected resource type.

Get the change history for one Deputy resource record.

Get one Company, Employee, Leave, OperationalUnit, Roster, or Timesheet record by its numeric ID.

Get a roster recommendation for the connected employee or supervised employees.

Get swap details for a roster belonging to the connected employee or supervised employees.

Get the check result for a Deputy bulk company-settings job by job ID.

Get the configured settings for a Deputy company or location by company ID.

Get Deputy's simplified location list for lightweight location selection.

Get the timezone configured for the connected user's Deputy company.

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.

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.

Get full Deputy records for all employees visible to the connected supervisor.

Get the Deputy employee record with the specified employee ID.

Get data for the specified employee-related resource category through Deputy's generic legacy route.

Get contracted-hours information for the specified Deputy employee.

Get HR onboarding information for the specified Deputy employee.

Read payroll connection information for the specified Deputy employee.

Read payroll synchronization information for the specified employee without starting a sync.

Read login-management information for the specified employee without changing login access.

Get Deputy's read-only validation result for the specified employee.

List the contracted-hours templates available for supervised employees.

Get the employee demo result exposed by Deputy's legacy supervisor API.

Get the invitation information returned by Deputy's zero-input employee invitation endpoint.

Get the employee subset Deputy's legacy API classifies as real employees.

Return the count of employees Deputy's legacy API classifies as real employees.

Read the employee-role management data exposed by Deputy; this operation does not change roles.

Get current shift information for an employee, optionally broadened across all companies by the required scope flag.

Get the current recommendation status for a Deputy roster by roster ID.

Get Deputy leave information for the specified employee.

Get leave information for an employee using Deputy's required leave setup selector.

List Deputy rosters from the previous 12 hours through the next 36 hours.

Get Deputy roster data for the specified date.

Get roster data for a Deputy company on the specified date.

Get a paginated roster result for a Deputy company and date, with an explicit selector for including open rosters.

Get bids for a roster by roster ID.

Get the status or result of an automatic Deputy roster-build job by job key.

Get the status or result of an automatic Deputy roster-fill job by job key.

Get Deputy's manager-notification information for the specified roster; this GET operation does not send a notification.

Get pending-approval swap details for a roster by roster ID.

List Deputy roster system templates using the required provider-defined numeric mode.

Get the check result for a Deputy bulk timesheet job by job ID.

Get Deputy timesheet information for an employee on the specified date.

Get Deputy unavailability information for the specified employee.

Get detailed timesheet data for the connected employee or supervised employees.

Get timesheet change history for the connected employee or supervised employees.

Get timesheet setup information for the connected employee or supervised employees.

List Deputy companies, workplaces, and payroll entities, or return one company when company_id is provided.

List roster templates for a Deputy company without changing them.

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.

List Gamingfy setup items without changing their state.

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.

Return one page of Deputy operational units (areas or departments), or one unit when operational_unit_id is provided.

List comments attached to one Deputy resource record.

List raw Company, Employee, Leave, OperationalUnit, Roster, or Timesheet records. Use the curated list tools when their safer reduced fields are sufficient.

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.

List roster swaps in a date range for the connected employee or supervised employees.

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.

Search colleague records visible to the connected Deputy user using a Deputy query object.

Create or update contact-address data for the connected Deputy user. Verify the request values before saving it.

Update emergency contact information for the connected Deputy user. Verify the request values before updating it.

Query locations awaiting approval for the connected Deputy user using a Deputy query object.

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.

Add a comment to the specified memo for the connected user. Verify the memo ID and comment content before creating it.

Apply the supplied memo change for the specified Deputy company. Verify the company ID and request values before updating it.

Update memo summary state for the connected Deputy user using the supplied request values.

Apply the supplied memo change for the specified Deputy team. Verify the team ID and request values before updating it.

Apply the supplied memo change for the specified Deputy user. Verify the user ID and request values before updating it.

Create or update the connected Deputy user's Net Promoter Score response.

Postpone the connected Deputy user's NPS response or prompt.

Update the connected Deputy user's named photo using the supplied photo request body.

Update the connected Deputy user's named preference using the supplied preference value.

Change Deputy support access for the connected user's account using the supplied support-access setting.

Create pending bids for the connected employee on eligible published open rosters that require approval.

Change the connected employee's pending bids on the specified rosters to withdrawn. Verify the roster IDs before updating them.

Create an offer for the specified roster record using the supplied offer details. Verify the roster ID before updating it.

Cancel the existing offer for the specified roster record. Verify the roster ID before updating it.

Request, cancel, accept, recommend, decline, or decline all for the specified roster swap. Verify the roster ID and selected operation before updating it.

Assign eligible published open rosters that do not require approval to the connected employee, closing those openings. Verify the roster IDs before updating them.

Create a new workplace in the connected Deputy account using the supplied workplace details.

Resolve an address and timezone from the supplied geographic coordinates without changing Deputy data.

Resolve geographic coordinates and a timezone from the supplied address without changing Deputy data.

Immediately send the supplied email to Deputy Customer Experience. Email delivery is external and cannot be undone.

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.

Validate the supplied Deputy workplace details and return the result without changing the workplace.

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.

Update the specified task for the connected Deputy user using the supplied request values.

Apply the supplied completion change to tasks for the connected Deputy user.

Apply the supplied department-task change for the connected Deputy user.

Apply the supplied department-task change for the connected Deputy user on the specified date.

Create or update a to-do item for the connected Deputy user. Verify the request values before saving it.

Create or update an unavailability record for the connected Deputy user. Verify the request values before saving it.

Update the supplied Deputy location settings across all locations. Verify the setting names and values before applying the broad change.

Update documented fields for a Deputy company or location by ID.

Archive the selected Deputy company or location so it is no longer active; verify the company ID before running.

Update documented settings for a Deputy company and cascade those values to eligible child records.

Permanently delete the Deputy company or location identified by company ID; verify the target before running.

Set or replace the Google Place ID associated with a Deputy company or location.

Update documented settings for one Deputy company or location by company ID.

Update the collection of department records associated with the specified Deputy location and return Deputy's untyped result object.

Update a Deputy department's location, name, address, payroll export name, display order, or area type by department ID.

Create a Deputy employee using the supplied name, location, and optional employment details.

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.

Update documented fields for an existing Deputy employee by employee ID.

Reactivate a terminated Deputy employee, returning the employee to active status.

Apply the supplied object to the selected employee-related category: memo, roster, timesheet, journal, leave, or employee availability.

Apply Deputy's documented contracted-hours mutation to an existing employee.

Permanently delete the selected employee's Deputy account; unlike termination, this removes the account record and cannot be undone.

Assign an HR onboarding record ID to the specified Deputy employee.

Run Deputy's documented HR payroll synchronization operation for the specified employee; verify payroll inputs before running.

Invite the selected employee to Deputy, sending a one-way external invitation that cannot be recalled; verify the employee ID and invitation details first.

Update the selected employee's photo using Deputy's documented photo object.

Reset the selected employee's two-factor authentication, invalidating the current second-factor setup so it must be configured again.

Send the selected employee Deputy's account-reset communication; this security-sensitive external message cannot be recalled.

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.

Apply an award from Deputy's library to selected employment agreements; if no agreement IDs are supplied, Deputy updates all agreements for the employee.

Apply a proven Deputy award contract template to selected employee agreements.

Terminate the specified Deputy employee. This changes employment status but is distinct from deleting the employee account.

Apply Deputy's documented mutation to a contracted-hours template using the supplied template object.

Update a Deputy contracted-hours template by template ID using the supplied documented fields.

Create one or more Deputy employees with each employee's first name, last name, and location ID.

Process an employee invitation using Deputy's documented invitation payload; use validation first when the payload is untrusted.

Search supervised employees using Deputy's employee query filters and return matching employee records.

Reset employee gender data using Deputy's documented reset object; verify the target data before running.

Validate employee data before creating or updating an employee; this check does not change workforce records.

Create or update Deputy's documented roster-timesheet record using the supplied relationship object.

Update employee recommendations for the specified roster using the supplied object and return Deputy's untyped result object.

Send an immediate, non-recallable workforce notification to the selected recommended employee for a roster; verify the roster and notification details first.

Send immediate, non-recallable workforce notifications to every recommended employee for a roster; verify the roster and notification details first.

Reset recommendations for a roster. This changes workforce recommendation state; verify the roster ID and payload before running it.

Update leave-management state for the leave record or request identified in the supplied object and return Deputy's untyped result object.

Create or update a Deputy roster using the supplied documented roster object.

Start an asynchronous job that creates unpublished Deputy shifts for selected areas and dates using staffing, coverage, or historical demand.

Create Deputy shifts from selected employees' agreed-hours profiles for specified areas, locations, and dates.

Start Deputy's documented GFE-based automatic roster-build operation using the supplied inputs.

Start an asynchronous job that assigns candidate employees to selected open Deputy shifts using bounded search and optimization settings.

Cancel the roster autofill operation identified by the supplied Deputy cancellation object.

Check or advance Deputy's documented roster autobuild-from-agreed-hours job using its job key and request object.

Check or advance Deputy's documented GFE-based roster-autobuild job using its job key and request object.

Copy Deputy roster data using the supplied source and destination settings.

Copy multiple rosters in one request using the supplied source and destination settings; verify every roster target before running.

Discard the Deputy roster state selected by the supplied documented object; verify the target before running.

Publish the Deputy roster selected by the supplied publication object, making the schedule externally visible.

Recalculate the selected timesheets in bulk; verify the timesheet selection and recalculation inputs before updating them.

Clock off an employee and end the selected active timesheet using Deputy's documented clock-off object.

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.

Clock on an employee and start a timesheet using Deputy's documented clock-on object.

Submit a Net Promoter Score response for the connected Deputy user.

Set the connected Deputy user's preference identified by key to the supplied value.

Add a Deputy location with its workplace name, address, and optional workplace, timezone, parent-company, and payroll settings.

Create a Deputy department from the supplied documented department fields.

Create multiple Deputy departments from the supplied documented department data.

Create a Deputy employee using the supplied documented employee fields.

Update contracted-hours details for an existing Deputy employee by employee ID; verify the employee and effective hours before running.

Create a Deputy contracted-hours template using the supplied documented template object.

Validate the supplied employee object through Deputy's legacy PUT validation route and return the validation result.

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.

Replace a self or supervised employee unavailability record by ID. Verify the target and complete replacement object first.

Save changes to roster-template data for a Deputy company.

Search one Deputy resource type with typed filters, sorting, offset pagination, and optional related-record expansion.

Associate an employee with a workplace or remove that relationship. Verify both IDs before changing it.

Mark a memo log read or unread for the connected Deputy user.

Complete or restore a task belonging to the connected Deputy user.

Update an existing Employee, Leave, OperationalUnit, Roster, or Timesheet record using Deputy's documented complete resource schema.