Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Keka HR PMS API
description: REST API for the Keka HR and payroll platform covering employee records, attendance, leave, payroll, expense management, performance, recruitment, professional services automation, helpdesk, background verification, and rewards.
version: v1
contact:
url: https://developers.keka.com/
license:
name: Keka Terms of Service
url: https://www.keka.com/terms-of-service
servers:
- url: https://{tenant}.keka.com/api/v1
description: Keka HR API
variables:
tenant:
default: your-company
description: Your Keka tenant subdomain
security:
- oauth2:
- kekaapi
tags:
- name: PMS
paths:
/api/v1/pms/timeframes:
get:
operationId: get_time_frame_list
summary: Get time frame list
tags:
- PMS
responses:
'200':
description: Successful response
description: 'This API is used for fetching list of all time frames.
Enumerated Values
TimeFrameStatus
0 = Active
1 = Hidden'
/api/v1/pms/goals:
get:
operationId: get_goal_list
summary: Get Goal list
tags:
- PMS
responses:
'200':
description: Successful response
description: 'This API is used for fetching list of all goals.
Enumerated Values
Goal Status
GoalMetricType
Goal Type
0 = NotStarted
1 = OnTrack
2 = NeedAttention
3 = AtRisk
4 = Closed
0 = Percentage
1 = Checkbox
3 = Number
0 = Individual
1 = Company
2 = Group'
/api/v1/pms/goals/{goalId}/progress:
put:
operationId: update_goal_progress
summary: Update goal progress
tags:
- PMS
responses:
'200':
description: Successful response
description: 'This API is used for updating progress against a specific goal.
Enumerated Values
Goal Status
GoalMetricType
Goal Type
0 = NotStarted
1 = OnTrack
2 = NeedAttention
3 = AtRisk
4 = Closed
0 = Percentage
1 = Checkbox
3 = Number
0 = Individual
1 = Company
2 = Group'
parameters:
- name: goalId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
example:
currentValue: '34'
status: '1'
updatedBy: d7fcfb1b-dec9-48a5-a0ab-247869d870bb
note: Test
/api/v1/pms/badges:
get:
operationId: get_badge_list
summary: Get badge list
tags:
- PMS
responses:
'200':
description: Successful response
description: 'This API is used for fetching list of all badges.
Enumerated Values
Badge Status
0 = Enabled
1 = Disabled'
/api/v1/pms/praise:
get:
operationId: get_praise_list
summary: Get praise list
tags:
- PMS
responses:
'200':
description: Successful response
description: This API is used for fetching list of all praises.
post:
operationId: create_praise
summary: Create Praise
tags:
- PMS
responses:
'200':
description: Successful response
description: This API is used for creating a praise.
/api/v1/pms/reviewgroups:
get:
operationId: get_review_group_list
summary: Get review group list
tags:
- PMS
responses:
'200':
description: Successful response
description: This API is used for fetching list of all review groups.
/api/v1/pms/reviewcycles:
get:
operationId: get_review_group_cycle_list
summary: Get review group cycle list
tags:
- PMS
responses:
'200':
description: Successful response
description: This API is used for fetching list of all review cycles.
/api/v1/pms/reviews:
get:
operationId: get_employee_review_list
summary: Get employee review list
tags:
- PMS
responses:
'200':
description: Successful response
description: This API is used for fetching list of all employee reviews.
components:
securitySchemes:
oauth2:
type: oauth2
description: OAuth 2.0 client credentials flow
flows:
clientCredentials:
tokenUrl: https://login.keka.com/connect/token
scopes:
kekaapi: Access to Keka HR API