Employees

Employees manage related operations

Resets the employee profile for a given email address, allowing the employee to select a new are and profile when they log in on the app

put

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Body

application/json*/*

The details of the employee you want to invite to Happyforce

namestringOptional

Name of the employee

emailstringOptional

Email of the employee

externalIdstringOptional

External id of the employee

hierarchyIdstringOptional

Area id where this employee belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

groupIdsstring[]Optional

List of groups to which this user belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

rolestring · enumOptional

Role of the employee in the company

Possible values:

managedHierarchiesstring[]Optional

List of hierarchies that this employee manages

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

application/json*/*

put

/v1/public/company/employees/reset

HTTPcURLJavaScriptPython

PUT /v1/public/company/employees/reset HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 315

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

application/json*/*

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

Retrieves an employee by external id

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Path parameters

externalIdstringRequired

The externalId of the employee you want to retrieve

Responses

200

OK

*/*

get

/v1/public/company/employees/externalid/{externalId}

HTTPcURLJavaScriptPython

GET /v1/public/company/employees/externalid/{externalId} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

Updates an employee for a given external id

put

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Path parameters

externalIdstringRequired

The externalId 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

externalIdstringOptional

External id of the employee

hierarchyIdstringOptional

Area id where this employee belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

groupIdsstring[]Optional

List of groups to which this user belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

rolestring · enumOptional

Role of the employee in the company

Possible values:

managedHierarchiesstring[]Optional

List of hierarchies that this employee manages

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

put

/v1/public/company/employees/externalid/{externalId}

HTTPcURLJavaScriptPython

PUT /v1/public/company/employees/externalid/{externalId} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 315

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

Deletes an employee for a given external id

delete

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Path parameters

externalIdstringRequired

The externalId 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

delete

/v1/public/company/employees/externalid/{externalId}

HTTPcURLJavaScriptPython

DELETE /v1/public/company/employees/externalid/{externalId} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

text

Retrieves an employee by email

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Path parameters

employeeEmailstringRequired

The email of the employee you want to retrieve

Responses

200

OK

*/*

get

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

HTTPcURLJavaScriptPython

GET /v1/public/company/employees/email/{employeeEmail} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

Updates an employee for a given email address

put

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

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

externalIdstringOptional

External id of the employee

hierarchyIdstringOptional

Area id where this employee belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

groupIdsstring[]Optional

List of groups to which this user belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

rolestring · enumOptional

Role of the employee in the company

Possible values:

managedHierarchiesstring[]Optional

List of hierarchies that this employee manages

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

put

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

HTTPcURLJavaScriptPython

PUT /v1/public/company/employees/email/{employeeEmail} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 315

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

Deletes an employee for a given email address

delete

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

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

delete

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

HTTPcURLJavaScriptPython

DELETE /v1/public/company/employees/email/{employeeEmail} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

text

Invite an employee

post

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Body

*/*

The details of the employee you want to invite to Happyforce

namestringOptional

Name of the employee

emailstringOptional

Email of the employee

externalIdstringOptional

External id of the employee

hierarchyIdstringOptional

Area id where this employee belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

groupIdsstring[]Optional

List of groups to which this user belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

rolestring · enumOptional

Role of the employee in the company

Possible values:

managedHierarchiesstring[]Optional

List of hierarchies that this employee manages

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

post

/v1/public/company/employees/invite

HTTPcURLJavaScriptPython

POST /v1/public/company/employees/invite HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 315

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-12-27T08:17:47.825Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

Retrieves all the employees

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

hierarchyIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6

activatedbooleanOptional

deletedbooleanOptional

Responses

200

OK

*/*

get

/v1/public/company/employees

HTTPcURLJavaScriptPython

GET /v1/public/company/employees HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "name": "text",
    "email": "text",
    "externalId": "text",
    "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
    "profile": [
      {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "date": "2025-12-27T08:17:47.825Z",
        "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
      }
    ],
    "groupIds": [
      "64f8a0e2d5b7c9a1e3f4a5b6"
    ],
    "role": "ADVISOR",
    "managedHierarchies": [
      "64f8a0e2d5b7c9a1e3f4a5b6"
    ]
  }
]