Before You Start

The Happyforce API is tailored for developers, engineers, and individuals who are adept at crafting custom-coded solutions or seamlessly integrating with RESTful APIs.

Scope of the API

The Happyforce API currently serves the following purposes:

1. Managing users within your account, granting you the ability to execute CRUD operations on user profiles.

2. Extracting statistical insights regarding the Happiness Index, Scores, and eNPS. This extraction can be filtered based on segments, dates, and other criteria.

3. Retrieving information about segments that are configured within your account, encompassing areas, demographics, and groups. This information proves essential for utilizing operations related to user management and statistical extraction.

Authentication

Authentication for the Happyforce API hinges on the utilization of API Keys, achieved by including the happyforceAPIKey header in each API request.

To obtain your unique Happyforce API Key, kindly navigate to the Happyforce Dashboard or ask for it from one of the Happyforce administrators.

You can find this key on Settings -> API & Badge -> Integration with Happyforce