### Get all Banks API Response Example Source: https://developers.keka.com/reference/bank Provides an example of a successful JSON response (200 OK) when fetching banks. It includes details on pagination, success status, messages, errors, and the structure of bank data. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get All Skills Response Example Source: https://developers.keka.com/reference/get_hris-skills This is an example of a successful (200 OK) response when retrieving all skills. It includes fields for success status, messages, errors, and paginated data containing skill IDs and names. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get All Clients Response Example Source: https://developers.keka.com/reference/clients This is an example of a successful (200 OK) response from the Keka API when retrieving clients. It includes fields like 'succeeded', 'message', 'errors', and 'data', with 'data' containing an array of client objects. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string", "code": "string", "description": "string", "billingAddress": { "addressLine1": "string", "addressLine2": "string", "countryCode": "string", "city": "string", "state": "string", "zip": "string" }, "clientContacts": [ { "id": "string", "clientId": "string", "name": "string", "email": "string", "phone": "string" } ], "attributes": { "additionalProp": "string" }, "additionalFields": [ { "id": "string", "title": "string", "value": "string" } ] } ] } ``` -------------------------------- ### Get all currencies API Response Example Source: https://developers.keka.com/reference/currency This is an example of a successful (200 OK) response when retrieving all currencies from the Keka API. It outlines the structure of the JSON response, including pagination details and currency data. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "code": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get all Asset Conditions - Example Response Source: https://developers.keka.com/reference/assetcondition This is an example JSON response for the 'Get all Asset Conditions' API call. It shows the structure of a successful response, including pagination details and a list of asset condition objects. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get all captureschemes API Response Example Source: https://developers.keka.com/reference/attendancecapturescheme This is an example of a successful (200 OK) response from the Keka API when retrieving capture schemes. It shows the structure of the returned JSON object, including pagination details and the list of capture schemes. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get all Pay Bands Response Example Source: https://developers.keka.com/reference/get_payroll-paybands This is an example of a successful (200 OK) response body when retrieving all pay bands. It includes success status, messages, errors, and detailed data about the pay bands along with pagination information. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get all departments API Response Example Source: https://developers.keka.com/reference/departments This is an example of a successful JSON response (200 OK) when retrieving all departments. It includes fields for success status, messages, errors, department data, and pagination details. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "parentId": "string", "name": "string", "description": "string", "isArchived": true, "departmentHeads": [ { "id": "string", "firstName": "string", "lastName": "string", "email": "string" } ] } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Example Response for Get all Asset Categories Source: https://developers.keka.com/reference/assetcategory This is an example of a successful JSON response (200 OK) when retrieving all asset categories. It includes fields for success status, messages, errors, and paginated data containing asset IDs and names. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get Taxes - Example Response (200 OK) Source: https://developers.keka.com/reference/get_psa-legalentity-legalentityid-taxes This is an example of a successful response (HTTP 200 OK) from the Keka API when retrieving tax information. It includes details about the success status, messages, errors, and the tax data itself, along with pagination information. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string", "taxRate": 0, "isEnabled": true } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get all Salary Structures (JSON Response Example) Source: https://developers.keka.com/reference/get_payroll-salarystructures This snippet provides an example of a successful JSON response when retrieving salary structures. It outlines the structure of the returned data, including pagination details and individual salary structure information. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string", "payGroupId": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get all expense policies API response example Source: https://developers.keka.com/reference/expensepolicy This snippet provides an example of a successful (200 OK) response body when retrieving expense policies. It outlines the structure of the JSON response, including fields like 'succeeded', 'message', 'errors', and 'data'. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Make POST Request with Keka API Source: https://developers.keka.com/reference/getting-started-with-your-api-1 This JavaScript snippet demonstrates how to make a POST request to a Keka API endpoint using the $http service. It includes a success callback function and an alert for confirmation. ```JavaScript $http.post('/someUrl', data).success(successCallback); alert('test'); ``` -------------------------------- ### Get Candidate Scorecards (Node.js) Source: https://developers.keka.com/reference/get_v1-hire-jobs-jobid-candidate-candidateid-scorecards Example of how to retrieve candidate scorecards using Node.js, likely with a library like 'axios' or 'node-fetch'. Assumes proper authentication setup. ```Node const axios = require('axios'); const getCandidateScorecards = async (company, environment, jobId, candidateId) => { const url = `https://${company}.${environment}.com/api/v1/hire/jobs/${jobId}/candidate/${candidateId}/scorecards`; try { const response = await axios.get(url, { headers: { 'accept': 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' // Replace with actual token } }); return response.data; } catch (error) { console.error('Error fetching scorecards:', error); throw error; } }; // Example usage: // getCandidateScorecards('mycompany', 'myenv', 'job123', 'candidate456'); ``` -------------------------------- ### Get Project by ID (Node.js) Source: https://developers.keka.com/reference/get_psa-projects-id-1 This example shows how to retrieve project information using the Keka API in Node.js. It outlines the request setup and the structure of the expected JSON response. ```javascript // Node.js example would go here, demonstrating the GET request and response handling. ``` -------------------------------- ### Create Keka Client with Ruby Source: https://developers.keka.com/reference/post_psa-clients-1 This Ruby example demonstrates creating a client via the Keka API using an HTTP POST request. It includes the endpoint URL and required parameters in the request body. ```Ruby require 'net/http' require 'uri' require 'json' def create_keka_client(company, environment, name, code, billing_info) uri = URI.parse("https://#{company}.#{environment}.com/api/v1/psa/clients") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true request = Net::HTTP::Post.new(uri.request_uri) request['accept'] = 'application/json' request['content-type'] = 'application/*+json' request.body = { name: name, code: code, billingInfo: billing_info }.to_json response = http.request(request) JSON.parse(response.body) end # Example usage: # puts create_keka_client('mycompany', 'dev', 'New Client', 'CLI001', { phone: '123-456-7890', website: 'http://example.com', email: 'contact@example.com' }) ``` -------------------------------- ### Example response for Get all noticeperiods Source: https://developers.keka.com/reference/get_hris-noticeperiods This is an example JSON response for the 'get all noticeperiods' API call. It includes fields for success status, messages, errors, and paginated data with notice period details such as ID and name. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Create Project using cURL Source: https://developers.keka.com/reference/post_psa-projects-1 This snippet demonstrates how to create a project using a cURL request. It includes the POST method, URL, and necessary headers for the request. ```Shell curl --request POST \ --url https://company.keka.com/api/v1/psa/projects \ --header 'accept: application/json' \ --header 'content-type: application/*+json' ``` -------------------------------- ### Get all Groups API Response Example Source: https://developers.keka.com/reference/get_hris-groups This is an example of a successful response (200 OK) from the 'Get all Groups' API endpoint. It includes a success status, a message, and an array of group data, along with pagination details. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string", "code": "string", "description": "string", "groupTypeId": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Create Project Response Example Source: https://developers.keka.com/reference/post_psa-projects-1 This snippet shows a successful response (200 OK) when creating a project via the Keka API. It includes fields like succeeded, message, errors, and data. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": "string" } ``` -------------------------------- ### Get Preboarding Candidates Response (JSON) Source: https://developers.keka.com/reference/get_v1-hire-preboarding-candidates This is an example JSON response for retrieving preboarding candidates. It outlines the structure of the data returned, including candidate details, pagination information, and sorting parameters. ```JSON { "items": [ { "id": "string", "firstName": "string", "middleName": "string", "lastName": "string", "email": "string", "countryCode": "string", "mobileNumber": "string", "jobtitle": "string", "gender": 0, "department": "string", "workLocation": "string", "expectedDateOfJoining": "2025-09-10T06:29:47.998Z", "stage": 0, "status": 0 } ], "page": 0, "pageSize": 0, "totalItems": 0, "totalPages": 0, "sortBy": "string", "sortOrder": "string" } ``` -------------------------------- ### Get Interview Details Response (JSON) Source: https://developers.keka.com/reference/get_v1-hire-jobs-jobid-candidate-candidateid-interviews This is an example JSON response from the Keka API when successfully retrieving interview details. It returns an array of interview objects, each containing details like ID, candidate ID, job ID, interview date, start and end times, time zone, and scheduling information. ```JSON [ { "id": "string", "candidateId": "string", "jobId": "string", "interviewDate": "string", "startTime": { "hours": 0, "minutes": 0 }, "endTime": { "hours": 0, "minutes": 0 }, "timeZoneId": "string", "scheduledBy": "string", "scheduledDate": "string", "interviewType": "string", "stageId": "string", "panelMembers": "string" } ] ``` -------------------------------- ### Create Keka Client with Python Source: https://developers.keka.com/reference/post_psa-clients-1 This Python example demonstrates creating a client via the Keka API. It uses the 'requests' library to send a POST request with the required JSON payload and headers. ```Python import requests import json def create_keka_client(company, environment, name, code, billing_info): url = f"https://{company}.{environment}.com/api/v1/psa/clients" headers = { 'accept': 'application/json', 'content-type': 'application/*+json' } payload = { 'name': name, 'code': code, 'billingInfo': billing_info } try: response = requests.post(url, headers=headers, json=payload) response.raise_for_status() # Raise an exception for bad status codes return response.json() except requests.exceptions.RequestException as e: print(f"Error creating client: {e}") return None # Example usage: # client_data = create_keka_client('mycompany', 'dev', 'New Client', 'CLI001', {'phone': '123-456-7890', 'website': 'http://example.com', 'email': 'contact@example.com'}) # print(client_data) ``` -------------------------------- ### Get All Expenses Response Example Source: https://developers.keka.com/reference/employeeexpense This snippet provides an example of a successful JSON response when retrieving employee expenses. It includes fields for success status, messages, errors, and the actual data. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": "string" } ``` -------------------------------- ### Get all project resources using cURL Source: https://developers.keka.com/reference/get_psa-project-resources This snippet demonstrates how to fetch all project resources using a cURL command. It specifies the GET request method, the API endpoint URL, and the 'accept' header for JSON response. ```Shell curl --request GET \ --url https://company.keka.com/api/v1/psa/project/resources \ --header 'accept: application/json' ``` -------------------------------- ### Get Holidays List Response Example Source: https://developers.keka.com/reference/get_time-holidayscalendar-calendarid-holidays This is an example of a successful response (200 OK) when retrieving holidays. It includes a success status, a message, and an array of holiday data, along with pagination details. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "date": "2025-09-10T06:29:41.144Z", "isFloater": true } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get Preboarding Candidates (cURL) Source: https://developers.keka.com/reference/get_v1-hire-preboarding-candidates This snippet demonstrates how to fetch preboarding candidates using a cURL request. It specifies the HTTP method, URL, and required headers for the API call. ```Shell curl --request GET \ --url https://company.keka.com/api/v1/hire/preboarding/candidates \ --header 'accept: application/json' ``` -------------------------------- ### Get Employee Financial Details (PHP) Source: https://developers.keka.com/reference/employeefinance This PHP example demonstrates fetching employee financial details via a GET request. It shows how to set up the cURL request, including the URL and headers, to interact with the Keka API. ```php ``` -------------------------------- ### Get all Job Boards (Ruby) Source: https://developers.keka.com/reference/get_v1-hire-jobboards-1 This snippet provides an example of how to make a GET request to the Keka API for job boards using Ruby. It typically involves using the 'Net::HTTP' library or a gem like 'httparty'. ```ruby # Example using Net::HTTP require 'net/http' require 'uri' uri = URI.parse('https://company.keka.com/api/v1/hire/jobboards') request = Net::HTTP::Get.new(uri) request['accept'] = 'application/json' response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| http.request(request) end puts response.body ``` -------------------------------- ### Get Project Tasks Response Example Source: https://developers.keka.com/reference/get_psa-projects-projectid-tasks-1 This is an example JSON response for a successful request to get project tasks. It includes fields like succeeded, message, errors, and a data array containing task details such as id, projectId, name, description, taskType, assignedTo, startDate, endDate, and estimatedHours. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "projectId": "string", "name": "string", "description": "string", "taskType": 0, "taskBillingType": 0, "assignedTo": [ { "id": "string", "employeeNumber": "string", "employeeName": "string" } ], "startDate": "2025-09-10T06:29:29.707Z", "endDate": "2025-09-10T06:29:29.707Z", "estimatedHours": 0 } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get Praise List Response Example Source: https://developers.keka.com/reference/get_pms-praise This is an example of a successful JSON response when retrieving praise records. It includes fields like 'succeeded', 'message', 'data' (containing praise details), and pagination information. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "feedback": "string", "badge": { "id": "string", "name": "string" }, "employees": [ { "id": "string", "employeeNumber": "string", "employeeName": "string" } ], "givenBy": { "id": "string", "employeeNumber": "string", "employeeName": "string" }, "givenOn": "2025-09-10T06:29:19.893Z" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Create Project Task (Ruby) Source: https://developers.keka.com/reference/post_psa-projects-projectid-tasks-1 Example of creating a project task using Ruby with the 'net/http' library. This demonstrates making a POST request with JSON data. ```ruby require 'uri' require 'net/http' require 'json' uri = URI.parse('https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks') request = Net::HTTP::Post.new(uri) request['accept'] = 'application/json' request['content-type'] = 'application/*+json' request.body = JSON.dump({ "projectId": "string", "name": "string", "description": nil, "taskBillingType": 0, "assignedTo": [ "string" ], "startDate": "2024-01-01T12:00:00Z", "endDate": "2024-01-01T12:00:00Z", "estimatedHours": nil, "phaseId": nil }) response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| http.request(request) end puts response.body ``` -------------------------------- ### Get all Pay Cycles Response Example Source: https://developers.keka.com/reference/get_payroll-paygroups-paygroupid-paycycles-1 This is an example of a successful JSON response when retrieving pay cycles. It includes details about the request's success, messages, errors, and the paginated data of pay cycles. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "identifier": "string", "month": "string", "startDate": "string", "endDate": "string", "runStatus": 0 } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Get Attachment Download URL Response Example Source: https://developers.keka.com/reference/get_payroll-declarations-attachments-downloadurl This is an example of a successful (200 OK) response from the Keka API when requesting an attachment download URL. It includes the fileURL, a message, and potential errors. ```JSON { "data": { "fileURL": "string" }, "message": "string", "errors": [ "string" ] } ``` -------------------------------- ### Post Preboarding Candidate using cURL Source: https://developers.keka.com/reference/post_v1-hire-preboarding-candidates This snippet demonstrates how to post a preboarding candidate using a cURL request. It includes the POST method, the target URL, and necessary headers for JSON content. ```Shell curl --request POST \ --url https://company.keka.com/api/v1/hire/preboarding/candidates \ --header 'accept: application/json' \ --header 'content-type: application/*+json' ``` -------------------------------- ### Get Billing Roles Response Example Source: https://developers.keka.com/reference/get_psa-clients-id-billingroles Provides an example JSON response for successfully retrieving billing roles. It outlines the structure of the 'data' object, including client ID, name, and billing rate details. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": { "id": "string", "name": "string", "billingRate": { "unit": 0, "rate": 0 } } } ``` -------------------------------- ### Create Project Task (PHP) Source: https://developers.keka.com/reference/post_psa-projects-projectid-tasks-1 Example of creating a project task using PHP with cURL. This shows how to set up the POST request with appropriate headers and JSON payload. ```php 'string', 'name' => 'string', 'description' => null, 'taskBillingType' => 0, 'assignedTo' => [ 'string' ], 'startDate' => '2024-01-01T12:00:00Z', 'endDate' => '2024-01-01T12:00:00Z', 'estimatedHours' => null, 'phaseId' => null ]; $headers = [ 'accept: application/json', 'content-type: application/*+json' ]; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); if (curl_errno($ch)) { echo 'Curl error: ' . curl_error($ch); } curl_close($ch); echo $response; ?> ``` -------------------------------- ### Get all weeklyoff policies - Response Example (JSON) Source: https://developers.keka.com/reference/attendanceweeklyoffpolicy This is an example of a successful JSON response when retrieving weekly off policies. It includes fields for success status, messages, errors, data, pagination details, and navigation links. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": [ { "id": "string", "name": "string" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" } ``` -------------------------------- ### Create Project Phase Response Example Source: https://developers.keka.com/reference/post_psa-projects-projectid-phases-1 This snippet shows a successful JSON response (200 OK) when creating a project phase. It includes fields for success status, messages, errors, and the returned data. ```JSON { "succeeded": true, "message": "string", "errors": [ "string" ], "data": "string" } ``` -------------------------------- ### Get all Job Boards (Python) Source: https://developers.keka.com/reference/get_v1-hire-jobboards-1 This snippet shows how to get job boards from the Keka API using Python, typically with the 'requests' library. It details setting up the request and handling the JSON response. ```python import requests url = "https://company.keka.com/api/v1/hire/jobboards" headers = { "accept": "application/json" } response = requests.get(url, headers=headers) if response.status_code == 200: print(response.json()) else: print(f"Error: {response.status_code}") ```