Employees

PreviousScores Metadata NextReset

Last updated 3 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

Responsestring

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

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-04-26T07:11:50.425Z",
        "valueId": "text"
      }
    ],
    "groupIds": [
      "text"
    ]
  }
]

Retrieves an employee by email

get

Authorizations

Path parameters

employeeEmailstringRequired

The email of the employee you want to retrieve

Responses

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-04-26T07:11:50.425Z",
      "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

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-04-26T07:11:50.425Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-04-26T07:11:50.425Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}