Jump to Content

Home Guides API Reference

Home Guides API Reference Discussions

Home Guides API Reference Log In

API Reference

All

Pages

Start typing to search…

Me

GET Meget

Companies

GET Companiesget
GET Companyget
GET Company Settingsget
PUT Company Settingsput
GET Number of requestsget
GET Businessget
GET Group permisionsget

Locations

GET Locationsget
GET Locationget
POST Locationpost
PUT Locationput
DELETE Locationdel

Positions

GET Positionsget
GET Positionget
POST Positionpost
PUT Positionput
DELETE Positiondel
GET Position break rulesget
POST Position break rulespost
DELETE Position break rulesdel

Employees

GET Employeesget
GET Employeeget
GET Employee by Employee IDget
GET Employee by Unique IDget
POST Employeepost
PUT Employeeput
DELETE Employeedel

Employee Positions

GET Employee positionsget
GET Employee positionget
POST Employee positionpost
DELETE Employee positiondel
PUT Employee positionput
GET Employee Manage Positionsget
POST Employee Manage Positionspost

Shifts

GET Shiftsget
GET Shiftget
POST Shiftpost
PUT Shiftput
DELETE Shiftdel
GET Clearget
GET Publishget

Shift Swap

POST Swappost
PUT Swapput

Trades

GET Tradesget
GET Tradeget
POST Tradepost
PUT Tradeput

Shifts Approve

GET Shift Approveget
POST Shift Approvepost
PUT Shift Approveput
DELETE Shift Approvedel

Shift Breaks

GET Shift Breaksget
POST Shift Breakspost
PUT Shift Breaksput
DELETE Shift Breaksdel

Timeclocks

GET Timeclocksget
GET Timeclockget
GET Timeclock statusget
POST Timeclockpost
PUT Timeclockput
DELETE Timeclockdel
POST Add clock timepost
POST Save Notepost
PUT Manage time clockput
PUT Force Clock Output

Timeclock Events

GET Timeclock eventget
POST Timeclock eventpost
PUT Timeclock eventput
DELETE Timeclock eventdel

Timeclock Location

GET Timeclock locationget
POST Timeclock locationpost
DELETE Timeclock locationdel

Timeclock Terminal

GET Timeclocks terminalget
GET Timeclock terminalget
POST Timeclock terminalpost
PUT Timeclock terminalput
DELETE Timeclock terminaldel

Terminal

POST Terminal clockinpost
POST Terminal loginpost
POST Terminal clockoutpost

Forecast

GET Forecast(Datatypes)get
GET Forecast(Datatype) by IDget
GET Forecast(Datatype) by unique_idget
POST Forecast(Datatype)post
PUT Forecast(Datatypes) by idput
PUT Forecast(Datatypes) by unique IDput
PUT Update imported historical dataput
DELETE Forecast(Datatype)del
DELETE Forecast(Datatype) by unique_iddel
GET Datapointget
POST Datapointpost
PUT Datapointput
DELETE Datapointdel
GET Datapointsget
POST COPY Datapointspost
GET Datapoint by datatype unique idget
PUT Datapoint by the datatype unique idput
POST COPY Datapoints by datatype unique IDpost
CREATE Datapointspost

Leaves

GET Leavesget
GET Leaveget
POST Leave Requestpost
POST Leave Request (hourly)post
PUT Leaveput
PUT Approving leave requestput
PUT Rejecting leave requestput
DELETE Leavedel

Leave-types

GET Leave typesget
DELETE Leave typedel
POST Leave typepost
PUT Leave Typeput
GET Leave types for a specific employeeget
PUT Enabling/Disabling leave types for employeesput

Payroll Ratecards

GET Ratecardsget
GET Ratecardget
POST Ratecardpost
PUT Ratecardput
DELETE Ratecarddel

Billing

GET Budgetget
POST Budgetpost

Messages

GET Messagesget
GET Messageget
POST Messagepost
DELETE Messagedel

Wall

GET Wall Messagesget
POST Wall Messagepost
DELETE Wall Messagedel
PUT Wall Messageput

Notices

GET Noticesget
GET Noticeget
POST Noticepost
PUT Noticeput
DELETE Noticedel

Employee Availability

GET Weekly Availabilityget
PUT Weekly Availabilityput
DELETE Weekly Availabilitydel
GET Future Availabilityget
POST Future Availabilitypost
PUT Future Availabilityput
DELETE Future Availabilitydel
GET Availability Approveget
POST Availability Approvepost
PUT Availability Approveput

Trainings

GET Training Progressget

Training Sections

GET Training Sectionsget
GET Training Sectionget
POST Training Sectionpost
PUT Training Sectionput
DELETE Training Sectiondel
PUT Training Section Syncput

Training Modules

GET Training Modulesget
GET Training Moduleget
POST Training Modulespost
PUT Training Moduleput
DELETE Training Moduledel
PUT Training Module Completeput
GET Training Module Signatureget
GET Training Module Commentsget
PUT Training Module Commentsput

Reports

GET Schedule Reportget
GET Timesheets Reportget
GET Employee Reportget
GET Custom Reportget
GET Daily Peak Hours Reportget
GET Workunits Daily Reportget
GET Payroll reportget

Employees Clockin:Out

GET Preclockinsget
GET Employees Preclockinget
POST Employees Preclockinpost
POST Employee clockinpost
PUT Employee clockoutput

Skills

GET Skillsget
GET Skillget
POST Skillspost
PUT Skillput
DELETE Skilldel

Employee Skills

CREATE Add skills to employeespost

Custom Fields

GET Custom Fieldsget
GET Custom Fieldget
POST Custom Fieldspost
PUT Custom Fieldsput
DELETE Custom Fielddel

Notes

GET Notesget
GET Noteget
POST Notepost
PUT Noteput
DELETE Notedel

Dashboard

GET Onnowget

Group Accounts

GET Group Reportsget

Availability (NEW)

Get availability in date periodpost
Get single availability slotget
Get multiplepost
Get availability by seriesget
Create single availabilitypost
Create availability seriespost
Approve availabilityput
Reject availabilityput
Reject seriesput
Delete seriesdel

Demand-Driven Scheduling

GET Data Pointsget
CREATE Data Pointspost
UPDATE Data Pointsput
CREATE Metricpost
GET Metricget
GET Metrics from Companyget
DELETE Metricdel

Shift Tasks

GET Master Tasksget
CREATE Master Taskspost
DELETE Master Tasksdel
UPDATE Master Taskspatch
GET Shift Tasksget
UPDATE Shift Tasksput
GET Employee Tasksget
UPDATE Employee Task Statuspost
UPDATE Employee Taskput

JSON

Getting Started With Your API

Powered by

GET Company

get

https://www.humanity.com/api/v2/companies/{id}

/companies/:id Permission level: 3

Language

Credentials

Query

Click Try It! to start a request and see the response here!