# ClayHR Documentation

> ClayHR API allows you to easily keep your employee and talent data in synch between your HR core and related IT systems.

## Getting Started: Documentation
- [Documentation](https://clayhr.readme.io/docs.md): ClayHR documentation

## API Endpoints: Authentication
- [Get Access Token for Authentication](https://clayhr.readme.io/reference/get-customer-configurations-from-public-customer-model-1.md): Get Access Token for Authentication using x-api-key and userId.

## API Endpoints: Announcements
- Announcement
  - [Create Announcement](https://clayhr.readme.io/reference/createannouncementusingpost.md)
  - [Retrieve Announcement](https://clayhr.readme.io/reference/editannouncementusingget.md)
  - [Update Announcement](https://clayhr.readme.io/reference/editannouncementusingput.md)
  - [Retrieve Announcement Attachments](https://clayhr.readme.io/reference/showdocumentlibraryinmobileusingget.md)

## API Endpoints: Attachments
- [Upload multiple files](https://clayhr.readme.io/reference/uploadmultiplefiles.md)
- [Fetch User Specific Attachments](https://clayhr.readme.io/reference/fetchuserspecificattachments.md): This will help you fetch User Specific Attachments
- [Retrieve attachments within document library](https://clayhr.readme.io/reference/get-attachments-within-document-library.md)
- [Retrieve document as byte array](https://clayhr.readme.io/reference/get-document-as-byte-array.md)

## API Endpoints: Candidates
- Candidates
  - [Retrieve candidates](https://clayhr.readme.io/reference/retrieve-candidates.md)
  - [Create new candidate](https://clayhr.readme.io/reference/create-a-new-candidate.md)
  - [Retrieve the candidate detail by recruitid](https://clayhr.readme.io/reference/retrieve-the-candidate-detail-by-recruitid.md)
  - [Retrieve candidates with basic details](https://clayhr.readme.io/reference/get-candidates-with-basic-details.md)
  - [Create a candidate from pdf resume](https://clayhr.readme.io/reference/create-a-candidate-from-pdf-resume.md)

## API Endpoints: Custom field
- Custom Fields
  - [Get Custom Fields.](https://clayhr.readme.io/reference/getcustomfieldsusingget.md)
  - [Add Custom List Entries](https://clayhr.readme.io/reference/savecustomlistentriesforcustomlist.md)

## API Endpoints: Custom group
- Custom Groups
  - [Get Custom Groups by Object ID.](https://clayhr.readme.io/reference/getcustomgroupsusingobjectid.md)

## API Endpoints: Dependents
- Dependents
  - [Delete dependent by contact ID](https://clayhr.readme.io/reference/delete-dependent-by-contactid.md)

## API Endpoints: Expense Reports
- Expense Reports
  - [Retrieve currencies](https://clayhr.readme.io/reference/get-currencies.md)
  - [Create expense report](https://clayhr.readme.io/reference/create-a-new-expense-item.md)
  - [Retrieve expense report details](https://clayhr.readme.io/reference/get-the-details-of-expense-report.md): Retrieve the details of expense report.
  - [Retrieve expense types](https://clayhr.readme.io/reference/get-expense-types.md)
  - [Retrieve expense reports](https://clayhr.readme.io/reference/get-expense-reports-by-user-id.md): Retrieve expense reports with User ID.
  - [Submit expense report](https://clayhr.readme.io/reference/submit-an-expense-report.md)
  - [Delete expense report](https://clayhr.readme.io/reference/delete-expense-report.md)
  - [Delete expense item](https://clayhr.readme.io/reference/delete-expense-item.md)
  - [Edit expense item](https://clayhr.readme.io/reference/edit-expense-report.md)
  - [Create expense item](https://clayhr.readme.io/reference/create-a-new-expense-item-2.md)

## API Endpoints: Forms
- Forms
  - [Retrieve forms](https://clayhr.readme.io/reference/getdynaformsusingget.md)
  - [Retrieve completed forms assigned to me  ](https://clayhr.readme.io/reference/getdynamicformsusingget.md)
  - [Retrieve form response ](https://clayhr.readme.io/reference/getdynaformresponsedetailsusingget.md)
  - [Retrieve form responses](https://clayhr.readme.io/reference/getdynaformsresponselistusingget.md)
  - [Save form repsonse ](https://clayhr.readme.io/reference/saveformresponseusingpost.md)
  - [Save item response](https://clayhr.readme.io/reference/saveitemresponseusingpost.md)
  - [Retrieve form details](https://clayhr.readme.io/reference/getdynaformdetailsusingget.md)

## API Endpoints: Goals
- Goals
  - [Get all goals.](https://clayhr.readme.io/reference/getgoalsusingget.md)
  - [Create a new goal.](https://clayhr.readme.io/reference/creategoalusingpost.md)
  - [Get goals by User Id.](https://clayhr.readme.io/reference/getgoalslistusingget.md)

## API Endpoints: Invoice
- Invoice
  - [Retrieve invoices by Project ID](https://clayhr.readme.io/reference/get-invoices-by-project-id.md)

## API Endpoints: Job Profiles
- Job Profiles
  - [Retrieve job profiles](https://clayhr.readme.io/reference/get-job-profiles.md)

## API Endpoints: Leaves
- Leaves
  - [Create a new leave.](https://clayhr.readme.io/reference/createleaveplanusingpost.md)
  - [Get remaining hours credit for leave policy](https://clayhr.readme.io/reference/getremaininghourscreditforleavepolicyusingget.md)
  - [Get PTO policies by User Id.](https://clayhr.readme.io/reference/getptopoliciesusingget.md)
  - [Create a new leave.](https://clayhr.readme.io/reference/createleaverequestusingpost.md)
  - [Get leave requests within a date range](https://clayhr.readme.io/reference/getleavelistusingget.md): Get leave request within a data range by using one of the following Authentication (access token) Techniques either by Authorization or by x-api-key and userId
  - [Get leaves for approval/rejection by filering on basis of Role](https://clayhr.readme.io/reference/getmanageleavelistusingget.md)
  - [Process the leave of a user by leave id](https://clayhr.readme.io/reference/processuserleavebyidusingget.md)
  - [Fetches who else is off leave list on the basis of start and end dates](https://clayhr.readme.io/reference/getleavelistforwhoelseoffusingget.md)
  - [Add PTO balance.](https://clayhr.readme.io/reference/adduserptobalancesusingpost.md)

## API Endpoints: Objectives
- Objectives
  - [Retrieve objectives](https://clayhr.readme.io/reference/get-objectives-by-user-id-or-specific-objective-by-objective-id.md): Retrieve objectives by user ID or specific objective by objective ID

## API Endpoints: Org relations
- Org Relations
  - [Retrieve all the OrgRelations for the given user.](https://clayhr.readme.io/reference/getorgrelationsforuserusingget.md): Retrieve all the OrgRelations for the given user including Active, Archive and Future OrgRelations.
  - [Retrieve all active OrgRelations](https://clayhr.readme.io/reference/getorgrelationsfororganizationusingget.md): Retrieve all active OrgRelations for entire organization.
  - [Saves the OrgRelation for the User](https://clayhr.readme.io/reference/savsorgrelationforuserusingget.md): Saves the OrgRelation for the User.

## API Endpoints: Org Units
- Org Units
  - [Retrieve org units](https://clayhr.readme.io/reference/retrieve-org-units.md)
  - [Create new org unit](https://clayhr.readme.io/reference/create-a-new-org-unit.md)

## API Endpoints: Paystubs
- Pay Stubs
  - [Retrieve my pay stubs](https://clayhr.readme.io/reference/get-pay-stubs-by-user-id.md)

## API Endpoints: Performace Review
- Performance Review
  - [Retrieve Performance Reviews](https://clayhr.readme.io/reference/get-performance-reviews-for-a-given-user.md)
  - [Retrieve Performance Review Templates](https://clayhr.readme.io/reference/get-performance-review-templates.md)
  - [Create Performance Review](https://clayhr.readme.io/reference/create-a-new-performance-review.md)
  - [Retrieve Completed Performance Reviews](https://clayhr.readme.io/reference/get-completed-performance-reviews-based-on-user-id.md)
  - [Launch Performance Reviews In Bulk](https://clayhr.readme.io/reference/launch-performance-reviews-in-bulk.md)

## API Endpoints: People and Permissions
- People and Permissions
  - [Create or Update user](https://clayhr.readme.io/reference/creates-or-updates-the-user-1-2.md): Creates a user, or updates the user if a match is found. The same call can also save addresses, education, employment history, contacts, compensation, custom field values and reporting managers.…
  - [Retrieve user details](https://clayhr.readme.io/reference/get-a-user-detail-with-user-id-2.md)
  - [Create user](https://clayhr.readme.io/reference/create-a-new-user-2.md)
  - [Update user](https://clayhr.readme.io/reference/update-user-2.md)
  - [Retrieve user basic information](https://clayhr.readme.io/reference/get-the-basic-information-of-user-2.md)
  - [Retrieve user financial record](https://clayhr.readme.io/reference/get-financial-record-of-user-2.md)
  - [Create compensation for user](https://clayhr.readme.io/reference/create-compensation-for-a-user-2.md)
  - [Update financial record of User](https://clayhr.readme.io/reference/update-financial-record-of-user-2.md)
  - [Retrieve a user or list of users](https://clayhr.readme.io/reference/get-a-user-or-list-of-users-2.md)
  - [Retrieve user permissions and menu configurations](https://clayhr.readme.io/reference/get-user-permissions-and-menu-configurations-2.md)
  - [Retrieve user financial status](https://clayhr.readme.io/reference/get-the-financial-status-of-a-user-2.md)
  - [Upload user profile](https://clayhr.readme.io/reference/upload-user-profile-picture-2.md)
  - [Retrieve all users details](https://clayhr.readme.io/reference/get-users-with-all-details-2.md)
  - [Retrieve basic user details](https://clayhr.readme.io/reference/get-users-with-basic-details-2.md)
  - [Retrieve users](https://clayhr.readme.io/reference/get-resources-2.md)
  - [Save User Address](https://clayhr.readme.io/reference/save-user-addresses-2.md)
  - [Save User Education](https://clayhr.readme.io/reference/save-user-educations-2.md)
  - [Save User Employment](https://clayhr.readme.io/reference/save-user-employments-2.md)
  - [Add reports to](https://clayhr.readme.io/reference/org-relation-api-2.md)
  - [Save Custom Field values](https://clayhr.readme.io/reference/save-custom-field-values-2.md)
  - [Delete User Address](https://clayhr.readme.io/reference/delete-user-address-2.md)
  - [Deletes User Employment](https://clayhr.readme.io/reference/deletes-user-employment-details-2.md)
  - [Delete User Education](https://clayhr.readme.io/reference/delete-user-education-2.md)

## API Endpoints: Performance Review Assigments
- Performance Review Assignment
  - [Retrieve Performance Review Assignments](https://clayhr.readme.io/reference/get-performance-review-assignments-for-a-user.md)

## API Endpoints: Positions
- Positions
  - [Save Position](https://clayhr.readme.io/reference/save-position.md)
  - [Retrieve position](https://clayhr.readme.io/reference/get-a-position-by-position-id.md)
  - [Retrieve positions](https://clayhr.readme.io/reference/get-positions.md)

## API Endpoints: Project
- Project
  - [List Allocations](https://clayhr.readme.io/reference/get-allocations-on-the-basis-of-project-id.md): Returns all user allocations for the project.
  - [Allocate Project](https://clayhr.readme.io/reference/save-project-allocation-by-project-id.md): Assigns the project to the user based on the project ID and user ID and returns the userProjectId, which is the ID of the assignment.
  - [Retrieve Project](https://clayhr.readme.io/reference/get-project-details-by-project-id.md): Retrieve the details of the Project by ID.
  - [List Projects](https://clayhr.readme.io/reference/get-projects-list.md): Returns a list of projects.
  - [Create Project](https://clayhr.readme.io/reference/create-a-project.md): Create a new project.

## API Endpoints: Reports
- Reports
  - [Get report](https://clayhr.readme.io/reference/getreportusingget.md)
  - [Get content for report by analytic Id](https://clayhr.readme.io/reference/getreportcontentusingget.md)

## API Endpoints: Skills
- Skills
  - [Create a new skill](https://clayhr.readme.io/reference/create-a-new-skill.md)
  - [Retrieve skills](https://clayhr.readme.io/reference/get-skills-by-cid.md)
  - [Retrieve skills assigned to a user](https://clayhr.readme.io/reference/get-skills-assigned-to-a-user.md)

## API Endpoints: Survey
- Survey
  - [Create the item's response for a survey](https://clayhr.readme.io/reference/saveitemresponseusingpost-1.md)
  - [Get a list of surveys](https://clayhr.readme.io/reference/getdynamicformsusingget-1.md)
  - [Create a survey response by assignment id](https://clayhr.readme.io/reference/saveformresponseusingpost-1.md)
  - [Get the details of a survey form by form id](https://clayhr.readme.io/reference/getdynaformdetailsusingget-1.md)

## API Endpoints: Shifts
- Shifts
  - [Get Shifts](https://clayhr.readme.io/reference/getshiftsusingget.md)
  - [Save Shift](https://clayhr.readme.io/reference/saveshiftusingpost.md)

## API Endpoints: Timecard
- Timecards
  - [Retrieve timecard details by User ID.](https://clayhr.readme.io/reference/getusertimecarddetailsusingget.md): Retrieve timecard details based on User ID with Add Time Cards For Other permission.
  - [Retrieve timecard basic details by User ID.](https://clayhr.readme.io/reference/gettimecardforuserusingget.md): Retrieve timecard basic details based on User ID with Add Time Cards For Other permission.
  - [Retrieve timecard details based on timecard ID.](https://clayhr.readme.io/reference/gettimecarddetailsbytimecardidusingget.md): Retrieve timecard details based on timecard ID with Add Time Cards For Other permission.

## API Endpoints: Timesheet
- Timesheets
  - [Retrieve timecards by Timesheet ID.](https://clayhr.readme.io/reference/gettimecardsusingget.md): Retrieve a list of timecards.
  - [Retrieve list of activity types based on cid.](https://clayhr.readme.io/reference/getactivitytypelistusingget.md): Retrieve list of activity types based on cid.
  - [Retrieve my active allocations.](https://clayhr.readme.io/reference/getallocationslistusingget.md): Retrieve list of active allocations of user.
  - [Clock in.](https://clayhr.readme.io/reference/clockinusingpost.md): Allows to clock in.
  - [Clock out.](https://clayhr.readme.io/reference/clockoutusingpost.md): Allows user to clock out.
  - [Delete a timesheet.](https://clayhr.readme.io/reference/deletetimesheetusingpost.md): Deletes a timesheet by Timesheet ID.
  - [Retrieve my timesheet preferences.](https://clayhr.readme.io/reference/gettimesheetpreferencesusingget.md): Retrieve list of timesheet preferences based in cid.
  - [Create/Update a timesheet.](https://clayhr.readme.io/reference/savetimesheetusingpost.md): Creates a new timesheet and update existing timesheet.
  - [Update timesheet status by Timesheet ID.](https://clayhr.readme.io/reference/updatetimesheetusingpost.md): Update the timesheet status (submit, approve, reject) corresponding to supplied Timesheet ID.
  - [Retrieve timesheets by User ID.](https://clayhr.readme.io/reference/gettimesheetsusingget.md): Retrieve a list of timesheets.
  - [Retrieve timesheet approvals.](https://clayhr.readme.io/reference/retrieve-a-list-of-timesheet-approvals-on-the-basis-of-permission.md): Retrieve list of timesheet approvals on the basis of permission.
  - [Retrieve a timesheet by timesheet ID.](https://clayhr.readme.io/reference/retrieve-timesheet-by-timesheet-id.md): Retrieve a timesheet by timesheet ID.
  - [Retrieve timesheet details by Timesheet ID.](https://clayhr.readme.io/reference/retrieve-timesheet-details-with-timesheet-id.md): Retrieve timesheet details by Timesheet ID.

## API Endpoints: Trainings
- Trainings
  - [Retrieve training content by training ID](https://clayhr.readme.io/reference/gettrainingcontentusingget.md)
  - [Update training status for user](https://clayhr.readme.io/reference/updateusertrainingstatususingpost.md)
  - [Retrieve my training assignments](https://clayhr.readme.io/reference/gettrainingsusingget.md)

## API Endpoints: Test
- [Retrieve test details](https://clayhr.readme.io/reference/gettestdetailsusingdynamicformid.md)
- [Retrieve list of assigned tests](https://clayhr.readme.io/reference/get-tests-assigned-to-a-user.md)
- [Retrieve the test by Status.](https://clayhr.readme.io/reference/gettestusingget.md): Retrieve the test by Status (Active, Archived, Draft)
- [Retrieve the test assignments by dynamicFormId](https://clayhr.readme.io/reference/retrieve-the-test-assignments-by-dynaformid.md): Retrieve the test assignments by dynamicFormId

## API Endpoints: User PTO Policies
- User PTO Policies
  - [Retrieve list of PTO policies](https://clayhr.readme.io/reference/get-list-of-pto-policies.md)
  - [Retrieve your PTO Policies](https://clayhr.readme.io/reference/get-details-of-a-pto-policy-by-user-id.md)