{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"483e5718-0ce6-4cdd-827a-cc57ac48387a","name":"Sprout API Services For Partners","description":"Sprout offers a suite of APIs that enable developers to integrate HR and Payroll functionalities into their systems. These APIs allow seamless data synchronization, process automation, and enhanced functionality for businesses looking to extend Sprout’s capabilities into their own applications.\n\n**Why Use Sprout APIs?**\n\nSprout’s API services provide developers with tools to:\n\n- **Automate HR & Payroll processes** – Reduce manual tasks and improve efficiency.\n    \n- **Ensure data consistency** – Keep employee, payroll, and attendance records accurate and up to date.\n    \n- **Enhance user experience** – Enable real-time updates, self-service, and streamlined HR operations.\n    \n- **Enable system interoperability** – Connect Sprout with third-party applications, such as payroll, accounting, or workforce management systems.\n    \n\n## API Key Requirement\n\nAll API requests require an **API key** for authentication. This key must be included in the request headers as:\n\n**Header Key**: `Ocp-Apim-Subscription-Key`  \n**Header Value**: Your assigned API key\n\n## Example Usage in Headers\n\n``` bash\n-H \"Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY\"\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"43000909","team":6869228,"collectionId":"483e5718-0ce6-4cdd-827a-cc57ac48387a","publishedId":"2sB34eGgS4","public":true,"publicUrl":"https://api-docs-partners-sandbox.sprout.ph","privateUrl":"https://go.postman.co/documentation/43000909-483e5718-0ce6-4cdd-827a-cc57ac48387a","customColor":{"top-bar":"FFFFFF","right-sidebar":"262B2B","highlight":"158039"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Comprehensive guide for developers integrating with Sprout Solutions’ HR and Payroll APIs. Includes authentication, endpoints, data models, sample requests, and best practices for ecosystem integration and third-party app support."},{"name":"title","value":"Sprout Solutions Public API Documentation For Partners"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/6e8a8ab3-edc2-46f6-a2f5-52b4749d12ed/RGFyayBNb2RlIExvZ28gKDMpLnBuZw==","colors":{"top-bar":"262B2B","right-sidebar":"262B2B","highlight":"158039"}},{"name":"light","logo":"https://content.pstmn.io/75b6848b-76d5-49d9-ba09-9f9ca68ff3dc/TGlnaHQgTW9kZSBMb2dvICgyKS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"262B2B","highlight":"158039"}}]}},"version":"8.10.0","publishDate":"2025-07-08T08:54:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Sprout Solutions Public API Documentation For Partners","description":"Comprehensive guide for developers integrating with Sprout Solutions’ HR and Payroll APIs. Includes authentication, endpoints, data models, sample requests, and best practices for ecosystem integration and third-party app support."},"logos":{"logoLight":"https://content.pstmn.io/75b6848b-76d5-49d9-ba09-9f9ca68ff3dc/TGlnaHQgTW9kZSBMb2dvICgyKS5wbmc=","logoDark":"https://content.pstmn.io/6e8a8ab3-edc2-46f6-a2f5-52b4749d12ed/RGFyayBNb2RlIExvZ28gKDMpLnBuZw=="}},"statusCode":200},"environments":[{"name":"Sandbox","id":"36482af1-73b1-46a0-8998-9c1003395ad0","owner":"43000909","values":[{"key":"envBaseUrl","value":"https://gateway-sb.sprout.ph","enabled":true,"type":"default"},{"key":"authBaseUrl","value":"{{envBaseUrl}}/auth","enabled":true,"type":"default"},{"key":"employeeBaseUrl","value":"{{envBaseUrl}}/empservice","enabled":true,"type":"default"},{"key":"employeeGatewayUrl","value":"{{envBaseUrl}}/employeeservice","enabled":true,"type":"default"},{"key":"hrGenBaseUrl","value":"{{envBaseUrl}}/hrgen","enabled":true,"type":"default"},{"key":"hrGenGatewayUrl","value":"{{envBaseUrl}}/hrgeneral","enabled":true,"type":"default"},{"key":"timeAttendanceBaseUrl","value":"{{envBaseUrl}}/timeattendance","enabled":true,"type":"default"},{"key":"timeAttendanceGatewayUrl","value":"{{envBaseUrl}}/timeandattendance","enabled":true,"type":"default"},{"key":"payrollBaseUrl","value":"{{envBaseUrl}}/payrollservice","enabled":true,"type":"default"},{"key":"payrollGatewayUrl","value":"{{envBaseUrl}}/sproutpayrollservice","enabled":true,"type":"default"}],"published":true}],"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/0257665dd6e52c577b6a9e81d81e932dd8c4d6f7069e0b1ae8ab175289959350","favicon":"https://res.cloudinary.com/postman/image/upload/v1743042550/team/6b4497bb4a192c5d5248c22e18d28214.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"},{"label":"Sandbox","value":"43000909-36482af1-73b1-46a0-8998-9c1003395ad0"}],"canonicalUrl":"https://api-docs-partners-sandbox.sprout.ph/view/metadata/2sB34eGgS4"}