Officient HR
Getting started
Reference
The Officient Developer Hub
Welcome to the Officient HR API docs. Let's jump right in!
v1.0
Home
Getting started
Tutorials
Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Getting started
Reference
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Documentation
Authentication
Input parameters
Rate limiting
Custom fields
Webhooks
Permission scopes
Documentation
Authentication
Input parameters
Rate limiting
Custom fields
Webhooks
Permission scopes
Authentication
post
Get access token
Account
get
Your account
People
get
List people
get
Search people
get
Person detail
post
Add person
post
Self-service invitation
patch
Edit person
put
Update manager
put
Update role
put
Upload avatar
Wages
get
Current wage
get
Wage history
One-off wage components
get
List available components
get
Components by person by month
post
Grant one-off wage component
delete
Remove one-off wage component
Calendar
get
Yearly calendar
get
Monthly calendar
get
Daily calendar
post
Add event
put
Overwrite event
delete
Delete event
patch
Update time worked
patch
Update time worked in bulk
post
Reset time worked
Calendar event types
get
Custom event types
get
Event type limits
post
Set event type limit
Calendar requests
get
List calendar requests
get
Calendar request detail
Assets
get
List assets
get
Asset detail
post
Add asset
patch
Edit asset
Asset types
get
List custom asset types
post
Add custom asset type
delete
Delete custom asset type
Fleet
get
List vehicles
get
Vehicle detail
post
Add vehicle
patch
Edit vehicle
Contracts
get
List contracts
get
Contract detail
get
Contract PDF
post
Add contract
post
Request contract signature
Documents
get
List documents
get
Download document
post
Upload document
delete
Delete document
Teams
get
List teams
post
Add team
patch
Edit team
Performance reviews
get
List performance reviews
Custom fields
get
List custom fields
patch
Edit custom field value
Webhooks
post
Add webhook
delete
Delete webhook
get
List webhooks
Powered by
Documentation
Authentication
Input parameters
Rate limiting
View All 6
Authentication
post
Get access token
Account
get
Your account
People
get
List people
get
Search people
get
Person detail
View All 9
Wages
get
Current wage
get
Wage history
One-off wage components
get
List available components
get
Components by person by month
post
Grant one-off wage component
View All 4
Calendar
get
Yearly calendar
get
Monthly calendar
get
Daily calendar
View All 9
Calendar event types
get
Custom event types
get
Event type limits
post
Set event type limit
Calendar requests
get
List calendar requests
get
Calendar request detail
Assets
get
List assets
get
Asset detail
post
Add asset
View All 4
Asset types
get
List custom asset types
post
Add custom asset type
delete
Delete custom asset type
Fleet
get
List vehicles
get
Vehicle detail
post
Add vehicle
View All 4
Contracts
get
List contracts
get
Contract detail
get
Contract PDF
View All 5
Documents
get
List documents
get
Download document
post
Upload document
View All 4
Teams
get
List teams
post
Add team
patch
Edit team
Performance reviews
get
List performance reviews
Custom fields
get
List custom fields
patch
Edit custom field value
Webhooks
post
Add webhook
delete
Delete webhook
get
List webhooks