Commonly Used API Operations

Click Boarding API endpoints are atomic, meaning each one does something discrete, and they build on one another. In other words, an ID from one call is needed for the next. 

Below is a list of the most commonly used API operations by our clients:

API Call	Description
Candidates-GET	Returns a list of employees for a client
Candidates/{id}-GET	Returns an employee shape for a specific employee
Candidates/{id}/Processes	Returns a specific employee's process flows
Candidates/{id}/Processes/{id}-GET	Returns a specific process flow’s information for a specific employee
FormDocument - GET	Returns an employee form
Candidates - POST	Creates a new employee
Candidates/{id} - PATCH	Updates an employee
Users - GET	Returns all Team Members
Users/{id} - GET	Returns data for a specific Team Member
Users - POST	Creates a new Team Member
Users/{id} - PATCH	Updates a Team Member
Locations-GET	Returns a list of the locations for the client
Locations/{id}-GET	Returns details about a specific location
Locations-POST	Creates a new location

 

Please visit the Developer Portal for documentation on all endpoints.