Jump to Content
Guides
Recipes
API Reference
Changelog
Log In
API Reference
Log In
Guides
Recipes
API Reference
Changelog
Get Locations
Search
JUMP TO
Deputy
Locations
Get Locations
get
Get simplified location list
get
Get a locations settings
get
Modify settings in a single location
post
Modify settings in all locations
post
Archive a location
post
Delete a location
post
Add a location
put
Update a location
post
Management
Add New Workplace
post
Get location by id
get
Create a memo
put
Find out an employees status
get
Post a journal
post
Find an employees leave
get
Add leave for a employee
post
Get suggestions for roster by id
get
Get unavailability details for a employee
get
Add unavailability details for a employee
post
Employees
Get details for all employees
get
Add an employee
post
Get details for a employee by id
get
Update an existing employee
post
Add a location against an employee
post
Remove a location from an employee
post
Terminate an employee
post
Re-activate a terminated employee
post
Delete an employees account in Deputy
post
Invite employee to Deputy
post
Set award for employee
post
Pay Rates
Get awards library list
get
Get Agreed Hours by Employee ID
get
Departments
Create a Department
put
Create Multiple Departments
put
Get Operational Units
get
Delete a Single Operational Unit
delete
Update a single operational unit
post
Rosters
Get a list of rosters from last 12 hours, and forward 36hours
get
Copy a Roster
post
Publish a roster
post
Discard a roster
post
Get rosters available for swap
get
Timesheets
Start an employees timesheet(ClockOn)
post
Stop an employees timesheet(ClockOff)
post
Pause or unpause employees timesheet (take a break/finish break)
post
View a timesheet by id
get
Sales
Add a sale to sales metrics
post
Retrieve Sales Data
get
Resource API
Example - Search for employees from a location
get
Logged in User Details
Where can I work /What do I do
get
What locations can I work in
get
My address on file
get
Update my address
post
Myaddressonfileincludingemergency
get
Get my subordinate contact details
get
Who do I work with?
get
When Am I Next Working
get
My Leave Requests
get
When Am I Unavailable
get
Get My Notifications
get
Get my training
get
Get my news feed
get
Get my tasks
get
Do a task
get
Get my timesheets
get
Get my individual timesheet
get
Utility request
Retrieve Current System Time
get
Retrieve current system time of a location
get
Webhooks
Add a webhook (URL)
post
Deputy Resource API
Resource API
Get Addresses
get
Search for address
post
Get Address Object Info
get
Get Categories
get
Search for Category
post
Get Category Object Info
get
Get Comments
get
Search for a comment
post
Get Comment Object Info
get
Get Locations
get
Search for a Location
post
Get Locations Object Info
get
Get Company Periods
get
Search for a Company Period
post
Get Company Period Object Info
get
Search for a contact
post
Get Contact Object Info
get
Search for a country
post
Get Country Object Info
get
Get Custom App Data entries
get
Search for a custom app data entry
post
Get Custom App Data Object Info
get
Get Custom Fields
get
Search for a Custom Field
post
Get Custom Field Object Info
get
Search for a custom field data entry
post
Get Custom Field Data Object Info
get
Search for an employee
post
Get Employee Object Info
get
Get Employee Agreements
get
Search for an employee agreement
post
Get Employee Agreement Object Info
get
Get Employee Agreement History
get
Search for an Employee Agreement History
post
Get Employee Agreement History Object Info
get
Get Employee Appraisals
get
Search for an Employee Appraisal
post
Get Employee Appraisal Object Info
get
Get Employee Availability
get
Search for an Employee Availability
post
Get Employee Availability Object Info
get
Get Employee History
get
Search for an Employee History
post
Get Employee History Object Info
get
Get Employee Roles
get
Search for an Employee Role
post
Get Employee Role Object Info
get
Get Employee Workplaces
get
Search for an Employee Workplace
post
Get Employment Conditions
get
Search for an Employment Condition
post
Get Employment Condition Object Info
get
Search for an Employment Contract
post
Get Employment Contract Object Info
get
Get Employment Contract Leave Rules
get
Search for Employment Contract Leave Rules
post
Get Employment Contract Leave Rules Object Info
get
Get Events
get
Search for Events
post
Get Event Object Info
get
Get Locations
get
https://{install}.{geo}.deputy.com/api/v1/resource/Company
Get Locations
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
URL
Base URL
https://
install
.
geo
.deputy.com/api
/v1/resource/Company
RESPONSE
Click
Try It!
to start a request and see the response here!