Jump to Content

Home Getting started Keka APIs

Marketplace Sign in →

Keka APIs

Home Getting started Keka APIs

Keka API

Overview
Authentication
Pagination
Rate Limit
Scope

Identity

Generate Access Token using API Keypost
App Portal: Access Token Generation
- Generate Access Token using OAuth Codepost
- Generate Access token using Refresh Tokenpost

Keka SSO API

Keka SSO Integration (Keka as Identity Provider)

Core Hr

Employees
Groups
- Get all Groupsget
- Get all Group Typesget
Departments
- Get all departmentsget
Locations
- Get all Locationsget
JobTitle
- Get all jobtitlesget
Currency
- Get all currenciesget
NoticePeriod
- Get all noticeperiodsget
ContingentType
- Get all Contingent Typesget
EmployeeExit
- Deactivate Employeepost
- Update Deactivate Employeeput
ExitReason
- Get all exitreasonsget

Document

DocumentTypes
- Gets the document types.get
EmployeeDocuments

Leave

LeaveTypes
- Get all Leave Typesget
LeaveBalance
- Get all Leave balancesget
LeaveRequests
- Get all Leave Requestsget
- Create Leave Requestpost
LeavePlans
- Get all Leave Plansget

Attendance

Attendance
- Get all Attendance Recordsget
AttendanceCaptureScheme
- Get all captureschemesget
AttendanceShiftPolicy
- Get all shift policiesget
AttendanceTrackingPolicy
- Get all trackingpoliciesget
AttendanceWeeklyOffPolicy
- Get all weeklyoff policiesget
Holiday
- Get holidays Listget
HolidayCalendar
- Get all holidays Calendarget
OnDuty
- Adds an OD requestpost
WorkFromHome
- Adds a WFH requestpost

Payroll

Salary
- Get all employee Salariesget
SalaryComponents
- Get all Salary Componentsget
PayGroups
- Get all Pay Groupsget
PayCycles
PayBands
- Get all Pay Bandsget
PayGrades
- Get all Pay Gradesget
FullAndFinalSettlement
- Get all Employee FnF Details.get
BonusType
- Get all Bonus Types.get
EmployeeFinance
- Get financial details of all employees.get
SalaryStructure
- Get all Salary Structures.get
EmployeeSalary
- Add Employee Salarypost
- Revise Employee Salaryput
Form16
- Gets employee form 16get
EmployeeAdhocTransaction
- Add the adhoc transactionput

PSA

Clients
CreditNotes
- Post credit notepost
Invoice
- Get invoice billing detailsget
- Post invoice paymentpost
Tax
- Gets Taxesget
TaxGroup
- Get Tax groups and taxesget
ProjectPhases
- Get project phases.get
- Create a Project Phasepost
Projects
ProjectResource
- Get all project resources.get
Tasks
TimesheetEntries
- Get project timesheet entries.get
- Add project task timesheet entries.post

Expense

EmployeeExpense
ExpenseAttachments
- Get Expense Attachment Download Urlget
ExpenseCategory
- Get all Expense Categoriesget
Advances
- To Fetch Advance Requestsget
- To update Advance statusput
ExpenseClaims
- Get all Expense Claimsget
- Update Expense Claim Payment Statusput
ExpensePolicy
- Get all expensepoliciesget

PMS

TimeFrames
- Gets time frame list.get
Goal
- Gets goal list.get
- Update goal progressput
Badge
- Gets badge list.get
Praise
- Gets praise list.get
- Add Praisepost
ReviewGroup
- Gets review group list.get
ReviewCycle
- Gets review cycle list.get
Review
- Gets employee review list.get

Keka Hire API

JobBoards
- Get all Job Boardsget
Jobs
Candidates
PreboardingAPI

Skills

Skill
- Gets all skills.get
EmployeeSkillsAPI
- Get employee skillsget
- Add employee skillspost

Assets

Asset
AssetType
- Get all Asset Typesget
AssetCategory
- Get all Asset Categoriesget
AssetCondition
- Get all Asset Conditionsget

Requisition

RequisitionRequest
- Get all Requisition Requestsget

Helpdesk

Helpdesk
HelpdeskCategory
- Get All Helpdesk Categoriesget
HelpdeskClosingReasons
- Get All Helpdesk Closing Reasonsget

Keka Workflow APIs

BGV Workflow APIs
Candidate Assessment Workflow APIs
RnR Workflow APIs
- Gets the employee reward points.get
- Updates the employee reward points.put
Digital Signature Workflow APIs

Groups

Enumerated Values

SystemGroupType
0 = None 1 = BusinessUnit 2 = Department 3 = OrgLocation 4 = CostCenter 5 = Paygroup 6 = ProjectTeam 7 = Team, 8 = ClientTeam 9 = LegalEntity

Table of Contents
- Enumerated Values