Articles in this section

Available Sprout Solutions APIs

When you configure an export, import, or other type of flow step using the prebuilt Sprout Solutions connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Sprout Solutions API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Clock in/out supported endpoints

Resource

API endpoint

Export

Import

Time attendance service: Attendance logs

Endpoint to create a batch of attendance log

Endpoint to get paginated list of attendance logs

Endpoint to batch delete biometric log

Endpoint to create a single attendance log

Endpoint to edit a single attendance log

Endpoint to get attendance log by ID

Endpoint to get paginated list of attendance logs by token/search criteria from cache

Endpoint to create search criteria cache for get attendance logs Request

Non-clock in/out supported endpoints

Resource

API endpoint

Export

Import

Employee service: Employees

Endpoint to update dependent of the employee

X

Endpoint to fetch employee access level

X

Endpoint to update employee government information

X

Endpoint to update employee work information

X

Endpoint to fetch assigned leave types of employee

X

Endpoint to fetch all employees

X

Endpoint to update employee contact information

X

Endpoint to update employee payroll information

X

Endpoint to fetch an employee

X

Endpoint to update employee salary information

X

Endpoint to fetch employee search

X

Endpoint to update employee educational backgrounds

X

Endpoint to update employee seminars

X

Endpoint to update employment records

X

Endpoint to update work schedule

X

Endpoint to update employee benefits

X

Endpoint to update employee assets

X

Endpoint to update employee performance management items

X

Endpoint to update employee memos

X

Endpoint to update employee visas

X

Endpoint to update employee pre-employment requirements

X

Endpoint to update employee trainings

X

Endpoint to update employee advances

X

Employee service: Lookups

Endpoint to fetch all visa types

X

Endpoint to fetch all countries

X

Assets category - GET

X

Endpoint to fetch all benefit types

X

Endpoint to fetch all departments

X

Endpoint to fetch all employment status

X

Endpoint to fetch all locations

X

HR general service: Access levels

Endpoint to get access level details

X

Endpoint to get access level details status

X

Endpoint to get access level by ID

X

Endpoint to get access level list

X

HR general service: Company

Endpoint to get company policy

X

HR general service: Health

Endpoint to get health status

X

HR general service: Lookups

Endpoint to get company list

X

Endpoint to fetch all departments

X

Endpoint to fetch all locations

X

Endpoint to fetch all employee types

X

Endpoint to fetch all benefit types

X

Endpoint to fetch all project status

X

Endpoint to fetch all asset category list

X

Endpoint to fetch all visa types

X

HR general service: Notifications

Endpoint to get notification list

X

Endpoint to get company mapping under a notification setting

X

Time attendance service: Approvals

Endpoint to get paginated list of get pending applications

X

Endpoint to create approvals

X

Time attendance service: Archived attendance logs

Endpoint to get paginated list of archived attendance logs by token/search criteria from cache

X

Endpoint to create search criteria cache for get archived attendance logs Request

X

Time attendance service: Attendance reports

Endpoint to get the summary attendance report for the user specified in the token or header

X

Endpoint to get the detailed attendance report for the users specified in the parameters

X

Endpoint to get the summary attendance report for the users specified in the parameters

X

Endpoint to get the detailed attendance report for the user specified in the token or header

X

Time attendance service: Leaves

Endpoint to calculate available and current leave credits

X

Endpoint to generate leave date breakdown and compute number of paid and unpaid days based on available leave credits

X

Endpoint to generate leave policies

X

Endpoint to generate leave date breakdown

X

Time attendance service: Lookups

Endpoint to fetch all certificate of attendance types

X

Endpoint to fetch a specific certificate of attendance type

X

Time attendance service: Requests

Endpoint to retrieve official business file attachment

X

Endpoint to retrieve an undertime request detail

X

Endpoint to retrieve leave file attachment

X

Endpoint to retrieve a certificate of attendance request detail

X

Endpoint to retrieve an official business request detail

X

Endpoint to retrieve paginated under time list

X

Endpoint to retrieve a schedule adjustment request detail

X

Endpoint to retrieve a leave request detail

X

Endpoint to retrieve an overtime request detail

X

Endpoint to retrieve an overtime initial request detail

X

Endpoint to retrieve paginated official business list

X

Endpoint to retrieve paginated certificate of attendance list

X

Endpoint to retrieve paginated schedule adjustment list

X

Endpoint to retrieve paginated overtime list

X

Time attendance service: Schedules

Endpoint to get paginated list of schedules

X

Time attendance service: Timesheets

Endpoint to get current lock information

X