The level of information you can access via the Humanforce API depends on the level of access that the linked-user has in Humanforce (i.e. if the Access Level cannot see timesheet information if it were logging in and using Humanforce, it can't extract timesheet information via an API call). This allows you to ensure that permissions are adequate, though not excessive.
Please ensure to adhere to the principle of least privilege when distributing Humanforce API Keys to any external vendors.
The table below indicates the permissions required for each request, for example:
POST https://humanforce.com/api/1.0/areas
Requires:
- Maintenance Screen
- Areas
- Allow Editing
| End Point | Method | Permission | Notes |
| All | All | REST API | This permission must be enabled for the API to access any data at all. |
| Allow API Access | |||
| /api/1.0/accessLevels | GET | Maintenance Screen | |
| Access Levels | |||
| /api/1.0/accessLevels | POST/PATCH/DELETE | Maintenance Screen | |
| Access Levels | |||
| Allow Editing | |||
| /api/1.0/accessPermissions | GET | Maintenance Screen | |
| Access Levels | |||
| /api/1.0/accessPermissions | POST/PATCH/DELETE | Maintenance Screen | |
| Access Levels | |||
| Allow Editing | |||
| /api/1.0/fieldPermissions | GET | Maintenance Screen | |
| Access Levels | |||
| /api/1.0/fieldPermissions | POST/PATCH/DELETE | Maintenance Screen | |
| Access Levels | |||
| Allow Editing | |||
| /api/1.0/areas | GET | Maintenance Screen | |
| Areas | |||
| /api/1.0/areas | POST/PATCH/DELETE | Maintenance Screen | |
| Areas | |||
| Allow Editing | |||
| /api/1.0/awardprofiles | GET | Maintenance Screen | |
| Profiles | |||
| /api/1.0/clocking/status | GET | TimeTarget Online | |
| View Clock Timesheets Page | |||
| /api/1.0/clocking/clockin | GET | TimeTarget Online | Will recived an Error 400 Bad Request if Employee has an active timesheet |
| View Clock Timesheets Page | |||
| /api/1.0/clocking/clockout | GET | TimeTarget Online | |
| View Clock Timesheets Page | |||
| /api/1.0/CostCentreMap | GET | Maintenance Screen | |
| Cost Centre Map | |||
| /api/1.0/CostCentreMap | POST/PATCH/DELETE | Maintenance Screen | |
| Cost Centre Map | |||
| Allow Editing | |||
| /api/1.0/DemandPlanInputValues | POST | TimeTarget Online | |
| View Administration Menu | |||
| View Demand Plan Feed Upload | |||
| Upload Demand Plan Feed Upload | |||
| /api/1.0/departments | GET | Maintenance Screen | |
| Departments | |||
| /api/1.0/departments | POST/PATCH/DELETE | Maintenance Screen | |
| Departments | |||
| Allow Editing | |||
| /api/1.0/availability | GET | TimeTarget Online | |
| View Availability Page | |||
| /api/1.0/leaverequest | GET | Availability Authorisation | |
| /api/1.0/leaverequest | POST/PATCH/DELETE | Availability Authorisation | |
| Allow Authorisation | |||
| /api/1.0/employees | GET | Maintenance Screen | |
| Note: The Field Permissions tab will also control which fields can also be accessed. | Employee Screen | ||
| /api/1.0/employees | ADD | Maintenance Screen | |
| Employee Screen | |||
| Allow Adding Employees | |||
| /api/1.0/employees | PATCH | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/roles | GET | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| Maintenance Screen | |||
| Roles | |||
| /api/1.0/employees/{guidKey}/roles | POST | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/ roles{roleGuidKey} |
DELETE | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/locations | GET | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| Maintenance Screen | |||
| Locations | |||
| /api/1.0/employees/{guidKey}/locations | POST | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/ locations{locationGuidKey} |
DELETE | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/departments | GET | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| Maintenance Screen | |||
| departments | |||
| /api/1.0/employees/{guidKey}/departments | POST | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/ departments/{departmentGuidKey} |
DELETE | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/roleRevisions | GET | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{guidKey}/roleRevisions | POST/PATCH/DELETE | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| Allow editing Role Pay Class Details (Award, Payrate, Rate) | |||
| /api/1.0/employees/{guidKey}/qualifications | GET | Maintenance Screen | |
| Employee Screen | |||
| /api/1.0/employees/{guidKey}/qualifications | POST/PATCH/DELETE | Maintenance Screen | |
| Employee Screen | |||
| Allow Editing Employees | |||
| /api/1.0/employees/{employeeGuidKey}/ qualifications/{qualificationGuidKey}/attachment |
GET/PATCH | Maintenance Screen | |
| Employee Screen | |||
| /api/1.0/employees/{guidKey}/leavebalances | GET | Availability Authorisation | |
| Access to Leave Accrual | |||
| /api/1.0/employees/{guidKey}/leavebalances | POST | Availability Authorisation | |
| Access to Leave Accrual | |||
| Allow Editing | |||
| /api/1.0/employees/onboard | POST | TimeTarget Online | |
| View Employee Onboarding | |||
| /api/1.0/employeeTitles | GET | Maintenance Screen | |
| Employee Titles | |||
| /api/1.0/employeeTitles | POST/PATCH/DELETE | Maintenance Screen | |
| Employee Titles | |||
| Allow Editing | |||
| /api/1.0/employmentTypes | GET | Maintenance Screen | |
| Employment Types | |||
| /api/1.0/employmentTypes | POST/PATCH/DELETE | Maintenance Screen | |
| Employment Types | |||
| Allow Editing | |||
| /api/1.0/events | GET | Maintenance Screen | |
| Events | |||
| /api/1.0/events | POST | Maintenance Screen | |
| Events | |||
| /api/1.0/events/{guidKey} | GET | Maintenance Screen | |
| Events | |||
| /api/1.0/events/{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Events | |||
| Allow Editing | |||
| /api/1.0/eventTypes | GET | Maintenance Screen | |
| Event Types | |||
| /api/1.0/eventTypes{guidKey} | GET | Maintenance Screen | |
| Event Types | |||
| /api/1.0/events/{eventGuidKey}/functions | GET | Maintenance Screen | |
| Events | |||
| /api/1.0/events/{eventGuidKey}/functions | POST | Maintenance Screen | |
| Events | |||
| Allow Editing | |||
| /api/1.0/events/{eventGuidKey}/ functions/{functionGuidKey} |
GET | Maintenance Screen | |
| Events | |||
| /api/1.0/events/{eventGuidKey}/ functions/{functionGuidKey} |
DELETE/PATCH | Maintenance Screen | |
| Events | |||
| Allow Editing | |||
| /api/1.0/genders | GET | Maintenance Screen | |
| Genders | |||
| /api/1.0/genders | POST/PATCH/DELETE | Maintenance Screen | |
| Genders | |||
| Allow Editing | |||
| /api/1.0/KPIInputValues | POST | Maintenance Screen | |
| Key Performance Indicators | |||
| /api/1.0/locations | GET | Maintenance Screen | |
| Locations | |||
| /api/1.0/locations{guidKey} | GET | Maintenance Screen | |
| Locations | |||
| /api/1.0/locations | POST | Maintenance Screen | |
| Locations | |||
| Allow Editing | |||
| /api/1.0/locations{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Locations | |||
| Allow Editing | |||
| /api/1.0/locationTypes | GET | Maintenance Screen | |
| Location Types | |||
| /api/1.0/locationTypes | POST | Maintenance Screen | |
| Location Types | |||
| Allow Editing | |||
| /api/1.0/locationTypes{guidKey} | GET | Maintenance Screen | |
| Location Types | |||
| /api/1.0/locationTypes{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Location Types | |||
| Allow Editing | |||
| /api/1.0/regions | GET | Maintenance Screen | |
| Regions | |||
| /api/1.0/regions{guidKey} | GET | Maintenance Screen | |
| Regions | |||
| /api/1.0/nationalities | GET | Maintenance Screen | |
| Nationalities | |||
| /api/1.0/nationalities{guidKey} | GET | Maintenance Screen | |
| Nationalities | |||
| /api/1.0/nationalities | POST | Maintenance Screen | |
| Nationalities | |||
| Allow Editing | |||
| /api/1.0/nationalities{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Nationalities | |||
| Allow Editing | |||
| /api/1.0/PayCompany | GET | Maintenance Screen | |
| Payroll Companies | |||
| /api/1.0/payRates | GET | Maintenance Screen | |
| Rates | |||
| /api/1.0/payRates | POST/PATCH/DELETE | Maintenance Screen | |
| Rates | |||
| Allow Editing | |||
| /api/1.0/payrunSummary | GET | Payroll Screen | |
| /api/1.0/payruns | GET | Payroll Screen | |
| /api/1.0/payruns/{payrunGuidkey}/ payrunTimesheets |
GET | Payroll Screen | |
| /api/1.0/payruns/{payrunGuidkey}/ payrunTimesheetPayTypes |
GET | Payroll Screen | |
| /api/1.0/payTypes | GET | Maintenance Screen | |
| Pay Types | |||
| /api/1.0/payTypes | POST/PATCH/DELETE | Maintenance Screen | |
| Pay Types | |||
| Allow Editing | |||
| /api/1.0/periods | GET | Maintenance Screen | |
| Shifts / Periods | |||
| /api/1.0/periods | POST/PATCH/DELETE | Maintenance Screen | |
| Shifts / Periods | |||
| Allow Editing | |||
| /api/1.0/publicHolidays | GET | Maintenance Screen | |
| Public Holidays | |||
| /api/1.0/publicHolidays{guidKey} | GET | Maintenance Screen | |
| Public Holidays | |||
| /api/1.0/publicHolidays | POST | Maintenance Screen | |
| Public Holidays | |||
| Allow Editing | |||
| /api/1.0/publicHolidays{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Public Holidays | |||
| Allow Editing | |||
| /api/1.0/publicHolidayTypes | GET | Public Holiday Types | |
| /api/1.0/publicHolidayTypes | POST | Maintenance Screen | |
| Public Holiday Types | |||
| Public Holidays | |||
| Allow Editing | |||
| /api/1.0/publicHolidayTypes{guidKey} | GET | Maintenance Screen | |
| Public Holiday Types | |||
| /api/1.0/publicHolidayTypes{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Public Holiday Types | |||
| Public Holidays | |||
| Allow Editing | |||
| /api/1.0/qualificationTypes | GET/POST/PATCH/DELETE | Maintenance Screen | |
| Qualification Types | |||
| /api/1.0/publicHolidayTypes{guidKey} | GET | Maintenance Screen | |
| Roles | |||
| /api/1.0/publicHolidayTypes{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Roles | |||
| Allow Editing | |||
| /api/1.0/roles | GET | Maintenance Screen | |
| Roles | |||
| /api/1.0/roles | POST | Maintenance Screen | |
| Roles | |||
| Allow Editing | |||
| /api/1.0/roles{guidKey} | PATCH/DELETE | Maintenance Screen | |
| Roles | |||
| Allow Editing | |||
| /api/1.0/rosterItems | GET | Rostering Screen | |
| /api/1.0/rosterItems/{guidKey} /payTypeValues |
GET | Rostering Screen | |
| /api/1.0/salesbudget | GET | Budgeting Screen | |
| Allow Editing | |||
| /api/1.0/shifttypes | GET | Maintenance Screen | |
| Shift Types | |||
| /api/1.0/shifttypes | POST/PATCH/DELETE | Maintenance Screen | |
| Shift Types | |||
| Allow Editing | |||
| /api/1.0/timesheets | GET | Timesheets Screen | |
| /api/1.0/timesheets | POST/PATCH/DELETE | Timesheets Screen | |
| Allow Editing | |||
| /api/1.0/timesheets/{guidKey}/ timesheetBreaks |
GET | Timesheets Screen | |
| /api/1.0/timesheets/{guidKey}/ timesheetAllowances |
GET | Timesheets Screen | |
| /api/1.0/timesheets/{guidKey}/ timesheetAllowances |
POST | Timesheets Screen | |
| Allow Editing | |||
| /api/1.0/timesheets/{guidKeyTimesheet}/ timesheetAllowances/{guidKeyAllowance} |
PATCH/DELETE | Timesheets Screen | |
| Allow Editing | |||
| /api/1.0/timesheets/{guidKey}/payTypeValues | GET | Timesheets Screen | |