HR General Service

View Documentation ↗

The HR General Service API lets you retrieve administrative and configuration-level data from the Sprout HR platform. This includes organizational structures, company settings, and potentially even system-triggered actions.

Key Capabilities

  • Fetch company info, department lists, locations, access levels, and roles.

  • Retrieve admin-level configuration settings seen in Sprout HR.

  • Trigger available HR transactions such as company announcements or system messages.

Under the Administrator View of Sprout HR, you can see all of the settings specific to your Sprout HR account and be able to manage them via the HR General Service.

When available, an example of a transaction that you can trigger with the HR General Service is the post announcements feature in Sprout HR.

For more information on the admin related features of Sprout HR, check out our knowledge base articles: https://sprout.zendesk.com/hc/en-us/sections/360004686214-I-m-an-Admin

Use Case Example:

A company syncs department and location details from Sprout HR to populate their internal employee directory or office seating tool.