Jump to Content
Home
Getting Started
API Endpoints
Log In
ClayHR
API Endpoints
Log In
ClayHR
Home
Getting Started
API Endpoints
/api/token
Search
All
Pages
Start typing to search…
JUMP TO
ClayHR REST APIs
Authentication
Get Access Token for Authentication
get
Announcement
Create Announcement
post
Retrieve Announcement
get
Update Announcement
put
Retrieve Announcement Attachments
get
Candidates
Retrieve candidates
get
Create new candidate
post
Retrieve the candidate detail by recruitid
get
Retrieve candidates with basic details
get
Create a candidate from pdf resume
post
Attachment
Upload multiple files
post
Fetch User Specific Attachments
get
Retrieve attachments within document library
get
Retrieve document as byte array
get
Custom Fields
Get Custom Fields.
get
Add Custom List Entries
post
Custom Groups
Get Custom Groups by Object ID.
get
Dependents
Delete dependent by contactId
post
Expense Reports
Retrieve currencies
get
Create expense report
post
Retrieve expense report details
get
Retrieve expense types
get
Retrieve expense reports
get
Submit expense report
post
Delete expense report
post
Delete expense item
post
Edit expense item
post
Create expense item
post
Forms
Retrieve forms
get
Retrieve form details
get
Retrieve form response
get
Save item response
post
Save form repsonse
post
Retrieve completed forms assigned to me
get
Feedback
Retrieve feedback
get
Goals
Retrieve Goal
get
Retrieve all goals
get
Create new goal
post
Retrieve goals of user
get
Delete Goal
del
Invoice
Retrieve invoices by Project Id
get
Job Profiles
Retrieve job profiles
get
Leaves
Retrieve remaining hours credit for leave policy
get
Create a new leave.
post
Retrieve leave requests within a date range
get
Retrieve leaves for approval/rejection by filtering on basis of Role
get
Process the leave of a user by leave Id
get
Fetches who else is off leave list on the basis of start and end dates
get
Add PTO balance.
post
Objectives
Retrieve objectives
get
Org Relation
Retrieve all the OrgRelations for the given user.
get
Retrieve all active OrgRelations
get
Saves the OrgRelation for the User
get
Org Units
Create new org unit
post
Retrieve org units
get
Pay Stubs
Retrieve my pay stubs
get
People and Permissions
Create user
post
Update user
post
Create or update the user
post
Retrieve user basic information
get
Retrieve user details
get
Retrieve basic user details
get
Retrieve users
get
Retrieve user financial record
get
Retrieve all users details
get
Retrieve user permissions and menu configurations
get
Upload user profile
post
Add reports to
post
Create compensation for user
post
Update financial record of User
post
Retrieve a user or list of users
get
Retrieve user financial status
get
Save User Address
post
Delete User Address
post
Save User Education
post
Delete User Education
post
Save User Employment
post
Deletes User Employment
post
Save Custom Field values
post
Performance Review
Create Performance Review
post
Retrieve Performance Review Templates
get
Retrieve Performance Reviews
get
Retrieve Completed Performance Reviews
get
Launch Performance Reviews In Bulk
post
Performance Review Assignments
Retrieve Performance Review Assignments
get
Positions
Save Position
post
Retrieve position
get
Retrieve positions
get
Project
Create Project
post
Retrieve Project
get
List Projects
get
List Allocations
get
Assign Project Allocation
post
Reports
Get report
get
Retrieve report content
get
Skills
Create a new skill
post
Retrieve skills
get
Retrieve skills assigned to a user
get
Survey
Retrieve all the Responses of the Survey
get
Create the item's response for a survey
post
Get a list of surveys
get
Create a survey response by assignment id
post
TVC code for clockin with QR Code using cid.
get
Get the details of a survey form by form id
get
Shifts
Get Shifts
get
Save Shift
post
Timecards
Retrieve timecard details by User ID.
get
Retrieve timecard basic details by User ID.
get
Retrieve timecard details based on timecard ID.
get
Timesheets
Retrieve timecards by Timesheet ID.
get
Retrieve list of activity types based on cid.
get
Retrieve my active allocations.
get
Clock in.
post
Clock out.
post
Delete a timesheet.
post
Retrieve my timesheet preferences.
get
Create/Update a timesheet.
post
Update timesheet status by Timesheet ID.
post
Retrieve timesheets by User ID.
get
Retrieve timesheet approvals.
get
Retrieve a timesheet by timesheet ID.
get
Retrieve timesheet details by Timesheet ID.
get
Trainings
Retrieve training content by training ID
get
Update training status for user
post
Sync with talent LMS
get
Retrieve trainings by user ID
get
Test
Retrieve the test by Status.
get
Retrieve list of assigned tests
get
Retrieve test details
get
Retrieve the test assignments by dynamicFormId
get
Workflows
Assign Workflow to User
post
Get workflows by user id.
get
Get tasks by userworkflowid.
get
Create task
post
Update status workflow task.
post
Get the details of a workflow task by task id.
get
Get tasks by user id.
get
Get workflows.
get
User PTO Policies
Expense Reports
/api/token
Expense Reports
Create expense report
post
Create expense item
post
Retrieve currencies
get
Retrieve expense report details
get
Retrieve expense types
get
Retrieve expense reports
get
Submit expense report
post
Delete expense report
post
Old collection
Retrieve document as byte array
get
Retrieve attachments within document library
get
Retrieve attachments within document library
get
Retrieve document as byte array
get
Fetch User Specific Attachments
get
Upload multiple files
post
Retrieve Announcement Attachments
get
Update Announcement
put
Retrieve Announcement
get
Create Announcement
post
Get Access Token for Authentication
get
Powered by
Ask AI
/api/token
