Employees

Retrieves an employee by email

get

/v1/public/company/employees/{employeeEmail}

Authorizations

Path parameters

employeeEmailstringrequired

The email of the employee you want to retrieve

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees/{employeeEmail}' \
  --header 'happyforceAPIKey: YOUR_API_KEY'

200

400

200

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-03-13T08:03:26.408Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

OK

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

put

/v1/public/company/employees/{employeeEmail}

Authorizations

Path parameters

employeeEmailstringrequired

The email of the employee you wish to update

Body

namestring

Name of the employee

emailstring

Email of the employee

hierarchyIdstring

profileobject[]

Entity representing the profile of one of your employees

groupIdsstring[]

List of groups to which this user belongs

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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-03-13T08:03:26.408Z",
        "valueId": "text"
      }
    ],
    "groupIds": [
      "text"
    ]
  }'

200

400

200

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-03-13T08:03:26.408Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

OK

Deletes an employee for a given email address

delete

/v1/public/company/employees/{employeeEmail}

Authorizations

Path parameters

employeeEmailstringrequired

The email of the employee you wish to delete

Query parameters

turnoverDatestring · date-time

The turnover date of the employee (ddMMyyyy format)

turnoverTypestring · enum

The type of turnover: Voluntary or involuntary

Options: VOLUNTARY, INVOLUNTARY, OTHER

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees/{employeeEmail}' \
  --header 'happyforceAPIKey: YOUR_API_KEY'

200

400

200

text

OK

Retrieves all the employees

get

/v1/public/company/employees

Authorizations

Query parameters

hierarchyIdstring[]

profilestring

groupIdstring[]

activatedboolean

deletedboolean

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees' \
  --header 'happyforceAPIKey: YOUR_API_KEY'

200

400

200

[
  {
    "name": "text",
    "email": "text",
    "hierarchyId": "text",
    "profile": [
      {
        "id": "text",
        "date": "2025-03-13T08:03:26.408Z",
        "valueId": "text"
      }
    ],
    "groupIds": [
      "text"
    ]
  }
]

OK