| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Resource | rest | https://{install}.{geo}.deputy.com/api/v1/resource | link | — | — | — |
| Management | rest | https://{install}.{geo}.deputy.com/api/management/v2 | link | — | — | — |
| Provisioning | rest | https://api.usw2.deputy.com/connect/v1 | link | — | — | — |
| Embed Partner Status | rest | https://api.usw2.deputy.com/connect/v1/partner | link | — | — | — |
Actions (34)
Locations · 10
- Add New WorkplacePOST /api/v1/my/setup/addNewWorkplace
Add a new workplace/location via the My setup API.
documented - Add locationPUT /api/v1/supervise/company
Create a new Deputy location.
documented - Archive locationPOST /api/v1/supervise/company/{id}/archive
Archive a Deputy location.
documented - Delete locationPOST /api/v1/supervise/company/{id}/delete
Delete a Deputy location.
documented - Get location by IDGET /api/v1/my/location/{id}
Retrieve a location by its ID.
documented - Get location settingsGET /api/v1/supervise/company/{id}/settings
Retrieve settings for a specific location (id).
documented - List locationsGET /api/v1/resource/Company
Retrieve the list of Deputy locations for the current install.
documented - List simplified locationsGET /api/v1/supervise/company/simple
Retrieve a simplified list of locations for quick reference.
documented - Update locationPOST /api/v1/supervise/company/{id}
Update an existing Deputy location.
documented - Update location settingsPOST /api/v1/supervise/company/{id}/settings
Update settings for a single location.
documented
Rosters · 5
- Copy rosterPOST /api/v1/supervise/roster/copy
Copy a roster.
documented - Discard rosterPOST /api/v1/supervise/roster/discard
Discard a roster post.
documented - Get rosters (list)GET /api/v1/supervise/roster
Get a list of rosters from the last 12 hours and forward 36 hours.
documented - Get rosters available for swapGET /api/v1/supervise/roster/autobuild
Retrieve rosters available for swap.
documented - Publish rosterPOST /api/v1/supervise/roster/publish
Publish a roster.
documented
Timesheets · 4
- Pause/unpause timesheetPOST /api/v1/supervise/timesheet/pause
Pause or unpause an employee's timesheet (take a break/finish break).
documented - Start timesheet (ClockOn)POST /api/v1/supervise/timesheet/start
Start an employee's timesheet (clock in).
documented - Stop timesheet (ClockOff)POST /api/v1/supervise/timesheet/end
End an employee's timesheet (clock out).
documented - View timesheet by IDGET /api/v1/supervise/timesheet/{timesheetid}/details
View a timesheet by its ID.
documented
Authentication · 3
- Me endpointGET https://{install}.{geo}.deputy.com/api/v1/me
Validate token and retrieve current user information.
documented - Me endpointGET /api/v1/me
Validate token and retrieve current user information.
documented - Who Am IGET https://{install}.{geo}.deputy.com/api/v1/me
Identify the user/account associated with the access token.
documented
Payroll · 3
- Get awards library listGET /api/v1/payroll/listAwardsLibrary
Retrieve pay/awards library for the install.
documented - Get awards library list (embed)GET /api/v1/payroll/listAwardsLibrary
Retrieve pay rate library awards.
documented - Set award from libraryPOST /api/v1/supervise/employee/{employeeid}/setAwardFromLibrary
Set an award from the pay rate library for an employee.
documented