# Before You Start

## Scope of the API <a href="#authentication" id="authentication"></a>

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.&#x20;

## Authentication

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

To obtain your unique Happyforce API Key, kindly navigate to the [Happyforce Dashboard](https://dashboard.myhappyforce.com) or ask for it from one of the Happyforce administrators.

You can find this key on **Settings -> API & Badge -> Integration with Happyforce** \ <br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api-docs.myhappyforce.com/docs/before-you-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.