{ "opencollection": "1.0.0", "info": { "name": "Keka HR Assets Core HR API", "version": "v1" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://login.keka.com/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Core HR", "type": "folder" }, "items": [ { "info": { "name": "Get all employees", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/employees" }, "docs": "

This API is used for fetching details of all employees.

\n

Enumerated Values

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\nThis API is used for creating a new Employee record.

\n

Enumerated Values

\n
TimeTypeWorkerTypeMaritalStatus
0 - None
1 - FullTime
2 - PartTime
0 - None
1 - Permanent
2 - Contingent
0 - None
1- Single
2 - Married
3 - Widowed
4 - Separated
\n\n\n\n\n\n\n\n\n\n\n\n\n\nUpdate Employee personal details

\n" }, { "info": { "name": "Update Employee Job Details", "type": "http" }, "http": { "method": "PUT", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/employees/8d04399f-8057-4b0d-ab0f-d9b9a5fb0376/jobdetails", "body": { "type": "json", "data": "{}" } }, "docs": "

Update employee job details

\n" }, { "info": { "name": "Get an employee", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/employees/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "

This API is used for fetching data of a specific employee by passing the employee ID as a URI parameter.

\n

Enumerated Values

\n
TimeTypeWorkerTypeMaritalStatus
0 - None
1 - FullTime
2 - PartTime
0 - None
1 - Permanent
2 - Contingent
0 - None
1- Single
2 - Married
3 - Widowed
4 - Separated
\n\n\n\n\n\n\n\n\n\n\n\n
TimeTypeWorkerTypeMaritalStatus
0 - None
1 - FullTime
2 - PartTime
0 - None
1 - Permanent
2 - Contingent
0 - None
1- Single
2 - Married
This API is used for fetching list of all groups.

\n

Enumerated Values

\n
\n\n\n\n\n\n\n\n\n\n\n
SystemGroupType
0 = None
1 = BusinessUnit
2 = Department
3 = OrgLocation
4 = CostCenter
5 = Paygroup
6 = ProjectTeam
7 = Team,
8 = ClientTeam
9 = Segment
\n
" }, { "info": { "name": "Get all group types", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/grouptypes" }, "docs": "

This API is used for fetching list of all group types.

\n

Enumerated Values

\n
\n\n\n\n\n\n\n\n\n\n\n
SystemGroupType
0 = None
1 = BusinessUnit
2 = Department
3 = OrgLocation
4 = CostCenter
5 = Paygroup
6 = ProjectTeam
7 = Team,
8 = ClientTeam
9 = Segment
\n
" }, { "info": { "name": "Get All Departments", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/departments" }, "docs": "Get All Departments" }, { "info": { "name": "Get all locations", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/locations" }, "docs": "

This API is used for fetching list of all locations.

\n

Enumerated Values

\n
\n\n\n\n\n\n\n\n\n\n\n
SystemGroupType
0 = None
1 = BusinessUnit
2 = Department
3 = OrgLocation
4 = CostCenter
5 = Paygroup
6 = ProjectTeam
7 = Team,
8 = ClientTeam
9 = Segment
\n
" }, { "info": { "name": "Get all job titles", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/jobtitles" }, "docs": "

This API is used for fetching list of all locations.

\n

Enumerated Values

\n
\n\n\n\n\n\n\n\n\n\n\n
SystemGroupType
0 = None
1 = BusinessUnit
2 = Department
3 = OrgLocation
4 = CostCenter
5 = Paygroup
6 = ProjectTeam
7 = Team,
8 = ClientTeam
9 = Segment
\n
" }, { "info": { "name": "Get all currencies", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/currencies" }, "docs": "

This API is used for fetching list of all currencies.

\n

Enumerated Values

\n
\n\n\n\n\n\n\n\n\n\n\n
SystemGroupType
0 = None
1 = BusinessUnit
2 = Department
3 = OrgLocation
4 = CostCenter
5 = Paygroup
6 = ProjectTeam
7 = Team,
8 = ClientTeam
9 = Segment
\n
" }, { "info": { "name": "Get All Noticeperiods", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/noticeperiods" }, "docs": "Get All Noticeperiods" }, { "info": { "name": "Get All Exitreasons", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/exitreasons" }, "docs": "Get All Exitreasons" }, { "info": { "name": "Create an Exit Request", "type": "http" }, "http": { "method": "POST", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/employees/bb3175e4-4cdb-425f-b034-b49069d53d6e/exitrequest", "body": { "type": "json", "data": "{}" } }, "docs": "

Create an exist request for an employee

\n
\n\n\n\n\n\n\n\n\n\n\n
Exit Type
0 - None
1 - Employee Resignation
2- Company Action
\n
" }, { "info": { "name": "Update Exit Request for Employee", "type": "http" }, "http": { "method": "PUT", "url": "https://{tenant}.keka.com/api/v1/api/v1/hris/employees/bb3175e4-4cdb-425f-b034-b49069d53d6e/exitrequest", "body": { "type": "json", "data": "{}" } }, "docs": "Update Exit Request for Employee" } ] } ], "bundled": true }