How to Integrate with Sprout

Sprout offers a suite of APIs that allow you to connect your internal systems with the Sprout platform — whether for employee syncing, leave automation, payroll data retrieval, and more. This guide walks you through the integration process from planning to going live.

Step 1: Define Your Integration Goal

Before reaching out, clearly outline what you aim to achieve. A well-scoped goal speeds up onboarding and ensures the right access is provisioned.

Ask yourself:

• What business problem are you solving?

• Is an API integration the right solution for it?

• What types of data or transactions do you need to interact with in Sprout? (e.g., employee profiles, time and attendance records, leave requests, payroll data)

• Do you need Full-Access or Restricted-Access — or both?

  • Full-Access returns complete data, including confidential fields such as Current Payroll Information and Salary History.

  • Restricted-Access returns a filtered dataset, excluding confidential sections. This is common for clients who want to limit exposure of sensitive employee data.

  • Note that Full-Access and Restricted-Access require different credentials, provisioning, and integration steps. It is important to determine this early.

Step 2: Coordinate with Your Customer Success Manager (CSM)

Reach out to your assigned CSM to kick off the onboarding process. Come prepared with the following:

• Integration goal — A concise description of your use case, including:

  • Whether you need HR, Payroll, or both

  • Whether you need Full-Access, Restricted-Access, or both

  • Specific integration use cases (e.g., employee sync, payroll data pull, leave automation)

• Developer email — The email of the developer responsible for the integration. This account will be registered in the Sandbox Developer Portal and provisioned with an API Key.

  Note: Only one API Key is provisioned per client for universal API call tracking.

• System dependencies — Any constraints or third-party systems involved in the integration.

Your CSM will then coordinate the provisioning of your sandbox environment.

Step 3: API Account Activation in Sandbox

Once provisioned, Sprout will provide documentation for your sandbox environment, which includes:

1. A working Sprout HR and/or Payroll site in the Sandbox environment

2. API Credentials (HR, Payroll, or both — depending on your scope)

3. Instructions on where to retrieve your API Key from the Developer Portal

   Note: The Sprout Sandbox is a shared, non-production environment available 24/7. It can be provisioned blank or pre-loaded with dummy data, but will never contain live production data.

Step 4: Build and Test

With your sandbox credentials ready, you can start building your integration. Replace the following placeholders with your account-specific values:

For sample API calls and full reference, see the detailed API Documentation.

Step 5: Production Go-Live

Once testing is complete and a go-live date has been decided, notify your CSM to begin Production onboarding. Before provisioning, prepare the following:

• Developer email for Production — A designated email for the Production API Key. This may be the same as sandbox or a different one, but must be explicitly provided for provisioning.

• Rate limit requirement — Coordinate with your CSM to determine the appropriate rate limit for your integration. This is tied to your pricing tier and will directly determine the Production API Key that gets provisioned for you.

Upon validation and processing of the Change Request Form (CRF), Sprout will send the following via email:

• client_id and client_secret tied to your Production tenant

• Guide on how to get the Production API Key provisioned based on your agreed rate limit

Once received, update your integration with the following Production-specific configurations:

• Replace all sandbox endpoint URLs with the corresponding Production URLs. Refer to the Sprout Production Developer Portal for the full list of Production endpoints.

• Replace your sandbox credentials (client_id, client_secret, and Ocp-Apim-Subscription-Key) with the Production values provided.

⚠️ Keep your Production credentials secure. Never expose them in frontend code or public repositories.