For AI agents: visit https://developer.deputy.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference Changelog

Guides

Guides API Reference Changelog

Required Reading

Getting Started with the Deputy API
The "Hello World" of Deputy
Getting Data - Resources API
Setting Data in Deputy
POSTMAN Collection
Glossary of Terms
Integration and Data Availability Options

Developer Guides

Point of Sale Developers
Payroll Developers
HR Developers
Fair Work Week and the Deputy API
Deputy Micro-scheduling
What makes a good integration with Deputy?

Authentication

Authenticating with Deputy Overview
Using Oauth 2.0

Employees

Employees Overview
Adding an Employee
Updating an employee using the V2 API
Retrieving an Employee
Retrieving an Employee's HR/Payroll data [New!]
Updating an Employee
Updating Regular Working Hours
Setting an Areas preferred employees
Updating an employees leave balance
Retrieving an Employees Pay Conditions
Adding a leave request for an employee
Setting an Employees Unavailability

Timesheets

Timesheets Overview
Getting Timesheets from Deputy
Creating or Updating a Timesheet
Starting/Stopping Timesheets (Clock in and Out)
Timesheet Management Calls
Marking a Timesheet as paid

Sales Data

Sales Data Overview
Adding a new custom metric
Adding Sales/Metric Data to Deputy
Retrieving Sales Data from Deputy

Budgets

Adding Hour Budgets to Deputy
Adding Wage Budgets to Deputy

Locations

Adding a location
Updating a location
Modifying location settings
Deleting/Archiving a location

Webhooks

Webhook Overview
Timesheet Webhook Example
New Employee Webhook Example
Manually Adding Webhooks to a Deputy Install
Webhook action list
AWS SQS
Custom Fields

Shifts

Shifts/Rosters Overview
Getting Shifts
Adding/Updating a Shift
Using the API to auto build Deputy shifts
Using the API to auto fill Deputy shifts
Micro-scheduling
Shift Offers

Smart Scheduling

Using the Deputy Labor Model - Overview
Creating a new Labor Model Rule
Retrieving the list of existing labor model rules
Running a Labor Model in Deputy
Updating an existing Labor Model

Custom Fields

Custom Fields Overview

Resource API Reference

Code Examples

Retrieve Future Rosters - Python

Custom Apps

Overview
Coding
DeXML
DeXML Native Functions

Report Writing

Overview

Misc

Newsfeed/Memo

Deputy Embed

What is Deputy Embed
Provisioning API - Security Overview
Create, Upgrade and Downgrade Deputy Embedded Accounts
Common errors & supporting your customers.
Calling APIs on behalf of a Deputy embedded account
Embed a Deputy install via iFrame
Managing Support for Embedded Accounts
Setting Pay Rates via the API
Unsupported in Deputy Embed Edition
Embed Partner Information API
Public API - Facts and Overview

Pay Rate Builder

Date Effective Pay Rates

Automated SFTP Upload

How to Use SFTP Uploads

Powered by

Retrieve Future Rosters - Python