For AI agents: the docs index is at https://developers.keka.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Keka APIMarketplace
HomeGetting startedKeka APIs
MarketplaceKeka API
Keka APIs
HomeGetting startedKeka APIs

Keka API

  • Overview
  • Authentication
  • Pagination
  • Rate Limit
  • Scope

KEKA API

  • Webhook Logs
    • Get webhook logsget

Identity

  • Generate Access Token using API Keypost
  • App Portal: Access Token Generation
    • Generate Access Token using OAuth Codepost
    • App portal app statusput
    • Generate Access token using Refresh Tokenpost
    • Read Installation parametersget

Keka SSO API

  • Keka SSO Integration (Keka as Identity Provider)
    • Authorize endpointget
    • Exchange Authorization Code for Tokenspost
    • Fetch User Detailsget

Core Hr

  • Employees
    • Get all Employeesget
    • Create an Employeepost
    • Get all update fieldsget
    • Search for an employee by work phone or email.post
    • Get an Employeeget
    • Update Employee personal detailsput
    • Update employee job detailsput
  • 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
    • Get Employee Documentsget
    • Get Employee Document Attachment Download Urlget
    • Upload Employee Documentspost

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
    • Post Attendance Records API
  • 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
  • EmployeeAttendanceTimeEntry
    • Adds the time entry to the attendance summarypost
    • Adds the time entry to the attendance summarypost
  • OnDuty
    • Adds an On Duty requestpost
    • Get all On Duty Requestsget
  • WorkFromHome
    • Adds a WFH requestpost
    • Get all WFH Requestsget
  • App
    • Update the app statusput
  • Helpdesk
    • Get All Helpdesk Ticketsget
    • Add Helpdesk Ticketpost
    • To Update Ticketput
  • HelpdeskCategory
    • Get All Helpdesk Categoriesget
  • HelpdeskClosingReasons
    • Get All Helpdesk Closing Reasonsget
  • Loans
    • Get All Loansget
    • Updates the loan details for the specified loan identifier, with support for multi-file upload.put
  • Regularisation
    • Get all Regularisation Requestsget

Payroll

  • Salary
    • Get all employee Salariesget
  • SalaryComponents
    • Get all Salary Componentsget
  • PayGroups
    • Get all Pay Groupsget
  • PayCycles
    • Get all Pay Cyclesget
    • Get Pay Registerget
    • Get all Pay Cyclesget
    • Get all Batch Paymentsget
    • Update the Payments statusput
    • Get all Pay Cyclesget
    • Get Pay Registerget
    • Get all Pay Cyclesget
    • Get all Batch Paymentsget
    • Update the Payments statusput
  • PayBands
    • Get all Pay Bandsget
  • PayGrades
    • Get all Pay Gradesget
  • FullAndFinalSettlement
    • Get all Employee FnF Details.get
  • App
    • Update the app statusput
  • Helpdesk
    • Get All Helpdesk Ticketsget
    • Add Helpdesk Ticketpost
    • To Update Ticketput
  • HelpdeskCategory
    • Get All Helpdesk Categoriesget
  • HelpdeskClosingReasons
    • Get All Helpdesk Closing Reasonsget
  • TaxDeclaration
    • Get employee tax declaration.get
    • Get Attachment Download Url.get
    • Update employee tax regime.put
    • Update individual tax declaration component.put
    • Create or update rental residence.post
    • Update own residencepost
    • Update income from other sourcespost
  • BonusType
    • Get all Bonus Types.get
  • EmployeeFinance
    • Get a paged list of financial details for all employees.get
    • update employee bank details.put
    • update employee financial details.put
  • SalaryStructure
    • Get all Salary Structures.get
  • EmployeeSalary
    • Add Employee Salarypost
    • Revise Employee Salaryput
    • Add Employee Salarypost
    • Revise Employee Salaryput
  • Bank
    • Get all Banksget
  • FlexiBenefit
    • Get flexi benefits get
    • Declare flexi benefitspost
  • Form16
    • Gets employee form 16get
    • Gets employee form 16get
  • SalaryComponentOverrides
    • Bulk Salary Component Overridepost
  • EmployeeAdhocTransaction
    • Add the adhoc transactionput
  • EmployeeComponentClaims
    • Get Employee Component Claimsget
    • Add Employee Component Claimpost
  • Loans
    • Get All Loansget
    • Updates the loan details for the specified loan identifier, with support for multi-file upload.put

PSA

  • Clients
    • Get all clientsget
    • Create a Clientpost
    • Get a clientget
    • Update a Clientput
    • Get a BillingRolesget
  • 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
    • Get all projects.get
    • Create a Projectpost
    • Get a projectget
    • Update a Projectput
    • Get a project allocationsget
    • Add a project allocationpost
    • Get project timesheet entries.get
    • Update a project allocationput
  • ProjectResource
    • Get all project resources.get
  • Tasks
    • Get project tasks.get
    • Create a taskpost
    • Update a taskput
    • Get project task time entries.get
  • TimesheetEntries
    • Get project timesheet entries.get
    • Add project task timesheet entries.post
    • Submit timesheet entries.post
  • Finances
    • Get billing rates for a rate cardget

Expense

  • EmployeeExpense
    • Get all Expensesget
    • Adds an Expensepost
    • Updates an expenseput
    • Get all Expensesget
    • Adds an Expensepost
    • Updates an expenseput
  • ExpenseAttachments
    • Get Expense Attachment Download Urlget
    • Get Expense Attachment Download Urlget
  • ExpenseCategory
    • Get all Expense Categoriesget
  • Advances
    • To Fetch Advance Requestsget
    • To update Advance statusput
    • To update Advance statusput
  • ExpenseClaims
    • Get all Expense Claimsget
    • Adds an Expense claim.post
    • Update Expense Claim Payment Statusput
    • 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
  • App
    • Update the app statusput
  • Helpdesk
    • Get All Helpdesk Ticketsget
    • Add Helpdesk Ticketpost
    • To Update Ticketput
  • HelpdeskCategory
    • Get All Helpdesk Categoriesget
  • HelpdeskClosingReasons
    • Get All Helpdesk Closing Reasonsget
  • Loans
    • Get All Loansget
    • Updates the loan details for the specified loan identifier, with support for multi-file upload.put

Keka Hire API

  • JobBoards
    • Get all Job Boardsget
  • Jobs
    • Get all jobsget
    • Get application fieldsget
    • Get candidate Resumeget
    • Upload candidate resumepost
  • Candidates
    • Get job candidatesget
    • Updated a candidateput
    • Adds candidate notepost
    • Post a job candidatepost
    • Get interview scheduled and completed for a job candidateget
    • Get scorecard of a specified candidate for a job candidateget
  • PreboardingAPI
    • Get all Preboarding Candidatesget
    • Post a Preboarding Candidatepost
    • update a Preboarding Candidateput

Skills

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

Assets

  • Asset
    • Get all Assetsget
    • To Update AssetAssignmentput
    • To Recover Assetput
  • AssetType
    • Get all Asset Typesget
  • AssetCategory
    • Get all Asset Categoriesget
  • AssetCondition
    • Get all Asset Conditionsget

Requisition

  • RequisitionRequest
    • Get all Requisition Requestsget

Helpdesk

  • Helpdesk
    • Get All Helpdesk Ticketsget
    • Add Helpdesk Ticketpost
    • To Update Ticketput
  • HelpdeskCategory
    • Get All Helpdesk Categoriesget
  • HelpdeskClosingReasons
    • Get All Helpdesk Closing Reasonsget

Keka Workflow APIs

  • BGV Workflow APIs
    • Create and Configure checks for a specific tenant
      • Get all checksget
      • Add bgv checks for a vendorpost
      • Delete bgv check for a vendordel
    • Get all bgvrequestsget
    • Add bgvRequest Reportput
  • Candidate Assessment Workflow APIs
    • Get all vendor assessmentsget
    • Add Assessmentspost
    • Update Assessmentsput
    • Delete Assessmentsdel
    • Assessment Request APIs
      • Get all vendor assessments requestsget
      • Add AssessmentResultpost
  • RnR Workflow APIs
    • Gets the employee reward points.get
    • Updates the employee reward points.put
  • Digital Signature Workflow APIs
    • Get Digital signature workflow request detailsget
    • Get Digital signature workflow documentget
    • Upload digitally signed documentput

Keka API Format

  • Getting Started With Your API
Powered by 

BGV Workflow APIs

Enumerated Values

BGVStatus
1 = Initiated
2 = ReportGenerated
3 = Completed
4 = Withdrawn

Updated over 1 year ago


Get All Helpdesk Closing Reasons
Create and Configure checks for a specific tenant
Did this page help you?

Updated over 1 year ago


Get All Helpdesk Closing Reasons
Create and Configure checks for a specific tenant
Did this page help you?