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 4 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

Possible values:
Responses
200
OK
*/*
Responsestring
400
Bad Request
*/*
delete
DELETE /api/v1/public/company/employees/{employeeEmail} HTTP/1.1
Host: api.myhappyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

text

Retrieves all the employees

get
Authorizations
Query parameters
hierarchyIdstring[]Optional
profilestringOptional
groupIdstring[]Optional
activatedbooleanOptional
deletedbooleanOptional
Responses
200
OK
*/*
400
Bad Request
*/*
get
GET /api/v1/public/company/employees HTTP/1.1
Host: api.myhappyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

[
  {
    "name": "text",
    "email": "text",
    "hierarchyId": "text",
    "profile": [
      {
        "id": "text",
        "date": "2025-05-17T05:15:56.228Z",
        "valueId": "text"
      }
    ],
    "groupIds": [
      "text"
    ]
  }
]
  • 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
200
OK
*/*
400
Bad Request
*/*
get
GET /api/v1/public/company/employees/{employeeEmail} HTTP/1.1
Host: api.myhappyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-05-17T05:15:56.228Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

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
groupIdsstring[]Optional

List of groups to which this user belongs

Responses
200
OK
*/*
400
Bad Request
*/*
put
PUT /api/v1/public/company/employees/{employeeEmail} HTTP/1.1
Host: api.myhappyforce.com
happyforceAPIKey: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 148

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-05-17T05:15:56.228Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}
{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-05-17T05:15:56.228Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}