Changeworknow HR API

An interactive tool to debug settings can be downloaded here: Windows | macOS.

Applications

Index	GET	/hr_api/v1/applications	Returns a list of complete Applications
Show	GET	/hr_api/v1/applications/:uuid	Return details of an existing Application

Business Units

Index	GET	/hr_api/v1/business_units	Returns a list of all Business Units
Show	GET	/hr_api/v1/business_units/:uuid	Return details of an existing Business Unit

Candidates

Index	GET	/hr_api/v1/candidates	Returns a list of successful Candidates
Show	GET	/hr_api/v1/candidates/:uuid	Return details of an existing Candidate

Configuration Scopes

Index	GET	/hr_api/v1/configuration_scopes	Returns a list of active Configuration Scopes
Show	GET	/hr_api/v1/configuration_scopes/:uuid	Return details of an existing Configuration Scope

Datahub Messages

Index	GET \| GET	/hr_api/v1/datahub/publisher/queues/:queue_uuid/messages	Returns a list of unprocessed Datahub Messages
Acknowledgement	POST \| POST	/hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/acknowledgement	Sets the status of a Message to acknowledged
Rejection	POST \| POST	/hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/rejection	Sets the status of a Message to rejected

Datahub Queues

Index

GET

/hr_api/v1/datahub/publisher/queues

Returns a list of Datahub Queues

Employees

Index	GET	/hr_api/v1/employees	Returns a list of Employees
Show	GET	/hr_api/v1/employees/:uuid	Return details of an existing Employee
Create	POST	/hr_api/v1/employees	Creates a new Employee
Update	PATCH \| PUT	/hr_api/v1/employees/:uuid	Updates an existing Employee
Destroy	DELETE	/hr_api/v1/employees/:uuid	Deletes an existing Employee

Employments

Index	GET	/hr_api/v1/employments	Returns a list of Employments
Show	GET	/hr_api/v1/employments/:uuid	Return details of an existing Employment
Create	POST	/hr_api/v1/employments	Creates a new Employment
Update	PATCH \| PUT	/hr_api/v1/employments/:uuid	Updates an existing Employment
Destroy	DELETE	/hr_api/v1/employments/:uuid	Deletes an existing Employment

Organizational Sub Units

Index	GET	/hr_api/v1/organizational_sub_units	Returns a list of active Organizational Sub Units
Show	GET	/hr_api/v1/organizational_sub_units/:uuid	Return details of an existing Organizational Sub Unit

Organizational Units

Index	GET	/hr_api/v1/organizational_units	Returns a list of active Organizational Units
Show	GET	/hr_api/v1/organizational_units/:uuid	Return details of an existing Organizational Unit

Position Opening Templates

Index	GET	/hr_api/v1/position_opening_templates	Returns a list of active Position Opening Templates
Show	GET	/hr_api/v1/position_opening_templates/:uuid	Return details of an existing Position Opening Template

Position Openings

Index	GET	/hr_api/v1/position_openings	Returns a list of open Position Openings
Show	GET	/hr_api/v1/position_openings/:uuid	Return details of an existing Position Opening

Position Reasons

Index	GET	/hr_api/v1/position_reasons	Returns a list of active Position Reasons
Show	GET	/hr_api/v1/position_reasons/:uuid	Return details of an existing Position Reason

Position Requisition Templates

Index	GET	/hr_api/v1/position_requisition_templates	Returns a list of active Position Requisition Templates
Show	GET	/hr_api/v1/position_requisition_templates/:uuid	Return details of an existing Position Requisition Template

Position Requisitions

Index	GET	/hr_api/v1/position_requisitions	Returns a list of open Position Requisitions
Show	GET	/hr_api/v1/position_requisitions/:uuid	Return details of an existing Position Requisition
Create	POST	/hr_api/v1/position_requisitions	Creates a new Position Requisition
Update	PATCH \| PUT	/hr_api/v1/position_requisitions/:uuid	Updates an existing Position Requisition
Destroy	DELETE	/hr_api/v1/position_requisitions/:uuid	Deletes an existing Position Requisition

Remuneration Package Keywords

Index	GET	/hr_api/v1/remuneration_package_keywords	Returns a list of active Remuneration Package Keywords
Show	GET	/hr_api/v1/remuneration_package_keywords/:uuid	Return details of an existing Remuneration Package Keyword

Screening Messages

Index	GET \| GET	/hr_api/v1/datahub/screening_messages	Returns a list of Screening Messages
Acknowledgement	POST \| POST	/hr_api/v1/datahub/screening_messages/:screening_message_message_uuid/acknowledgement	Sets the status of a Message to acknowledged
Rejection	POST \| POST	/hr_api/v1/datahub/screening_messages/:screening_message_message_uuid/rejection	Sets the status of a Message to rejected

Shift Keywords

Index	GET	/hr_api/v1/shift_keywords	Returns a list of active Shift Keywords
Show	GET	/hr_api/v1/shift_keywords/:uuid	Return details of an existing Shift Keyword

Termination Reasons

Index	GET	/hr_api/v1/termination_reasons	Returns a list of active Termination Reasons
Show	GET	/hr_api/v1/termination_reasons/:uuid	Return details of an existing Termination Reason

User Groups

Index	GET	/hr_api/v1/user_groups	Returns a list of User Groups
Show	GET	/hr_api/v1/user_groups/:uuid	Return details of an existing User Group

Worksites

Index	GET	/hr_api/v1/worksites	Returns a list of active Worksites
Show	GET	/hr_api/v1/worksites/:uuid	Return details of an existing Worksite
Create	POST	/hr_api/v1/worksites	Creates a new Worksite
Update	PATCH \| PUT	/hr_api/v1/worksites/:uuid	Updates an existing Worksite
Destroy	DELETE	/hr_api/v1/worksites/:uuid	Deletes an existing Worksite