{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c0165541-ba13-4dd3-855b-9f33831fb486","name":"Darwinbox APIs","description":"[Darwinbox](https://www.darwinbox.com) is a global end-to-end cloud-based HRMS platform. Darwinbox APIs allow you to programmatically access data stored in your Darwinbox instance or import data into Darwinbox. Our APIs are accessible only to privileged users and access would be provided on a request-only basis.\n\nWe publish enhancements to our APIs on a monthly basis. Please reach out to us at [integrationsteam@darwinbox.in](https://mailto:integrationsteam@darwinbox.in) for any queries you might have on our APIs.\n\n**Happy 'POST'ing!**\n\n# Authentication\n\nAll the APIs at Darwinbox currently support either Basic Auth or OAuth 2.0 Authentication mechanisms. Based on your preference and/or configuration, either of the above methods can be chosen for all the APIs listed below in our documentation.\n\n### 1.Basic Auth\n\nBasic Authentication (often abbreviated as \"Basic Auth\") is a simple authentication method used to secure access to web resources. It works by requiring a client to provide a username and password when making a request to a server.\n\nAll data at our endpoints are secured by a dual-factor auth mechanism with endpoint authorization. A username/password and api_key pair are securely generated at our server-side. The API user will have to pass this username & password in tandem with the api_key to gain access to the related endpoint.\n\nOnce you have received the above data, these will have to be used in the following way to access the product APIs. Below is a sample Curl provided for the Employee Master API\n\n``` json\ncurl --location '\nhttps://{{subdomain}}.darwinbox.in/masterapi/employee'\n\\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Basic dXNlcl9pZDpBYmhpc2hla0AzMjE=' \\\n--data '{\n    \"api_key\": \"b78cwr481404n8cbxn0478nxr4tc0b23t6c780t4cb7\",\n    \"datasetKey\": \"ee34bb5ec33f0e3fcd627489a12aa1842f3a93be2b202b59175f330bf6ed74e6ae25936bc09d734dbbcd49998229e308eeeaba5596202c35f2bad2fe819\",\n    \"employee_ids\": [\n        \"EMP001\",\n        \"EMP002\"\n    ]\n}'\n\n```\n\n### 2\\. OAuth 2.0\n\nOAuth 2.0 is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. It works by allowing users to authorize third-party applications to access their information without exposing their passwords.\n\nThis section contains the Authentication APIs, which needs to be used to generate the dynamic Auth token. This token will further be used for the business APIs, whichever was configured at the time of API Key generation\n\nOnce you configure a dynamic key in the Darwinbox UI, you will have 3 values with you\n\n- Authorization Code\n- Client Id\n- Client Secret Key\n    \n\nUsing all these 3 values, you will have to use the Auth Token APIs as mentioned below","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4130699","team":202397,"collectionId":"c0165541-ba13-4dd3-855b-9f33831fb486","publishedId":"SWDzg2Pp","public":true,"publicUrl":"https://api-docs.darwinbox.com","privateUrl":"https://go.postman.co/documentation/4130699-c0165541-ba13-4dd3-855b-9f33831fb486","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0183FF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/5cea32f2-e054-44d1-9c1b-52fc367bf4d6/REIgQmxhY2sgbG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0183FF"}},{"name":"light","logo":"https://content.pstmn.io/cd7409d9-6269-439f-a939-da4525803bf3/REIgV2hpdGUgbG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0183FF"}}]}},"version":"8.10.1","publishDate":"2024-06-18T05:36:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/cd7409d9-6269-439f-a939-da4525803bf3/REIgV2hpdGUgbG9nby5wbmc=","logoDark":"https://content.pstmn.io/5cea32f2-e054-44d1-9c1b-52fc367bf4d6/REIgQmxhY2sgbG9nby5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://darwinbox.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.darwinbox.com/view/metadata/SWDzg2Pp"}