Happyforce API
  • Welcome
  • Before You Start
  • Data Segmentation in Happyforce
  • API reference
    • Hierarchy
    • Characteristics
    • Groups
    • Scores Metadata
    • Employees
      • Reset
      • Invite
    • Stats
      • Hi
      • Enps
      • Scores
      • Activation
      • Participation
  • Specification
Powered by GitBook
On this page

Was this helpful?

  1. API reference

Employees

PreviousScores MetadataNextReset

Last updated 2 months ago

Was this helpful?

Deletes an employee for a given email address

delete
Authorizations
Path parameters
employeeEmailstringrequired

The email of the employee you wish to delete

Query parameters
turnoverDatestring · date-timeoptional

The turnover date of the employee (ddMMyyyy format)

turnoverTypestring · enumoptional

The type of turnover: Voluntary or involuntary

Available options:
Responses
*/*
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees/{employeeEmail}' \
  --header 'happyforceAPIKey: YOUR_API_KEY'
200
400
text

OK

Retrieves all the employees

get
Authorizations
Query parameters
hierarchyIdstring[]optional
profilestringoptional
groupIdstring[]optional
activatedbooleanoptional
deletedbooleanoptional
Responses
*/*
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees' \
  --header 'happyforceAPIKey: YOUR_API_KEY'
200
400
[
  {
    "name": "text",
    "email": "text",
    "hierarchyId": "text",
    "profile": [
      {
        "id": "text",
        "date": "2025-04-04T03:26:48.034Z",
        "valueId": "text"
      }
    ],
    "groupIds": [
      "text"
    ]
  }
]

OK

  • GETRetrieves an employee by email
  • PUTUpdates an employee email address or hierarchy for a given email address
  • DELETEDeletes an employee for a given email address
  • GETRetrieves all the employees

Retrieves an employee by email

get
Authorizations
Path parameters
employeeEmailstringrequired

The email of the employee you want to retrieve

Responses
*/*
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees/{employeeEmail}' \
  --header 'happyforceAPIKey: YOUR_API_KEY'
200
400
{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-04-04T03:26:48.034Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

OK

Updates an employee email address or hierarchy for a given email address

put
Authorizations
Path parameters
employeeEmailstringrequired

The email of the employee you wish to update

Body

The details of the employee you want to invite to Happyforce

namestringoptional

Name of the employee

emailstringoptional

Email of the employee

hierarchyIdstringoptional
profileobject[]optional

Employee profile data, used for later segmentation

groupIdsstring[]optional

List of groups to which this user belongs

Responses
*/*
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees/{employeeEmail}' \
  --header 'happyforceAPIKey: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": "text",
    "email": "text",
    "hierarchyId": "text",
    "profile": [
      {
        "id": "text",
        "date": "2025-04-04T03:26:48.034Z",
        "valueId": "text"
      }
    ],
    "groupIds": [
      "text"
    ]
  }'
200
400
{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-04-04T03:26:48.034Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

OK