When you configure an export, import, or other type of flow step using the prebuilt Deputy connector, you can select any of the API operations listed below, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Deputy API documentation. You can also create a composite endpoint for this application in HTTP mode.
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Departments |
Create a department |
X |
|
|
Create multiple departments |
X |
||
|
Get operational units |
X |
||
|
Delete a single operational unit |
X |
||
|
Update a single operational unit |
X |
||
|
Employees |
Get details for all employees |
X |
|
|
Add an employee |
X |
||
|
Get details for an employee by ID |
X |
||
|
Update an existing employee |
X |
||
|
Add a location against an employee |
X |
||
|
Remove a location from an employee |
X |
||
|
Terminate an employee |
X |
||
|
Re-activate a terminated employee |
X |
||
|
Delete an employee account in Deputy |
X |
||
|
Invite employee to Deputy |
X |
||
|
Set award for employee |
X |
||
|
Locations |
Get locations |
X |
|
|
Add a location |
X |
||
|
Get simplified location list |
X |
||
|
Get location settings |
X |
||
|
Modify settings in a single location |
X |
||
|
Modify settings in all locations |
X |
||
|
Archive a location |
X |
||
|
Delete a location |
X |
||
|
Update a location |
X |
||
|
Logged-in user details |
Who am I |
X |
|
|
Where can I work/what do I do |
X |
||
|
What locations can I work in |
X |
||
|
My address on file |
X |
||
|
Update my address |
X |
||
|
My address on file including emergency |
X |
||
|
Get my subordinate contact details |
X |
||
|
Who do I work with |
X |
||
|
When am I next working |
X |
||
|
My leave requests |
X |
||
|
When am I unavailable |
X |
||
|
Get my notifications |
X |
||
|
Get my training |
X |
||
|
Get my newsfeed |
X |
||
|
Get my tasks |
X |
||
|
Do a task |
X |
||
|
Get my timesheets |
X |
||
|
Get my individual timesheet |
X |
||
|
Management |
Add new workplace |
X |
|
|
Get location by ID |
X |
||
|
Create a memo |
X |
||
|
Find out an employee status |
X |
||
|
Post a journal |
X |
||
|
Find an employee leave |
X |
||
|
Add leave for an employee |
X |
||
|
Get suggestions for roster by ID |
X |
||
|
Get unavailability details for an employee |
X |
||
|
Add unavailability details for an employee |
X |
||
|
Pay rates |
Get awards library list |
X |
|
|
Resource |
Get address object info |
X |
|
|
Get addresses |
X |
||
|
Get categories |
X |
||
|
Get category object info |
X |
||
|
Get comment object info |
X |
||
|
Get comments |
X |
||
|
Get company period object info |
X |
||
|
Get company periods |
X |
||
|
Get contact object info |
X |
||
|
Get country object info |
X |
||
|
Get custom app data object info |
X |
||
|
Get custom app data entries |
X |
||
|
Get custom field data object info |
X |
||
|
Get custom field object info |
X |
||
|
Get custom fields |
X |
||
|
Get employee agreement history |
X |
||
|
Get employee agreement history object info |
X |
||
|
Get employee agreement object info |
X |
||
|
Get employee agreements |
X |
||
|
Get employee appraisal object info |
X |
||
|
Get employee appraisals |
X |
||
|
Get employee availability |
X |
||
|
Get employee availability object info |
X |
||
|
Get employee history |
X |
||
|
Get employee history object info |
X |
||
|
Get employee object info |
X |
||
|
Get employee role object info |
X |
||
|
Get employee roles |
X |
||
|
Get employee workplaces |
X |
||
|
Get employment condition object info |
X |
||
|
Get employment conditions |
X |
||
|
Get employment contract leave rules |
X |
||
|
Get employment contract leave rules object info |
X |
||
|
Get employment contract object info |
X |
||
|
Get event object info |
X |
||
|
Get events |
X |
||
|
Get locations |
X |
||
|
Get location object info |
X |
||
|
Search for category |
X |
||
|
Search for employment contract leave rules |
X |
||
|
Search for events |
X |
||
|
Search for a company period |
X |
||
|
Search for a custom field |
X |
||
|
Search for a location |
X |
||
|
Search for a comment |
X |
||
|
Search for a contact |
X |
||
|
Search for a country |
X |
||
|
Search for a custom app data entry |
X |
||
|
Search for a custom field data entry |
X |
||
|
Search for address |
X |
||
|
Search for an employee agreement history |
X |
||
|
Search for an employee appraisal |
X |
||
|
Search for an employee availability |
X |
||
|
Search for an employee history |
X |
||
|
Search for an employee role |
X |
||
|
Search for an employee workplace |
X |
||
|
Search for an employment condition |
X |
||
|
Search for an employment contract |
X |
||
|
Search for an employee |
X |
||
|
Search for an employee agreement |
X |
||
|
Search for employees from a location |
X |
||
|
Rosters |
Get roster on a specific date and location |
X |
|
|
Copy a roster |
X |
||
|
Publish a roster |
X |
||
|
Discard a roster |
X |
||
|
Get rosters available for swap |
X |
||
|
Sales |
Add a sale to sales metrics |
X |
|
|
Retrieve sales data |
X |
||
|
Timesheets |
Start an employee timesheet (clock on) |
X |
|
|
Stop an employee timesheet (clock off) |
X |
||
|
Pause or unpause employee timesheet (take a break/finish break) |
X |
||
|
View a timesheet by ID |
X |
||
|
Utility request |
Retrieve current system time |
X |
|
|
Retrieve current system time of a location |
X |
||
|
Webhooks |
Add a webhook (URL) |
X |