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

put
/v1/public/company/employees/reset
200

OK

Retrieves an employee by external id

get
Authorizations
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}
200

OK

Updates an employee for a given external id

put
Authorizations
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}
200

OK

Deletes an employee for a given external id

delete
Authorizations
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}
200

OK

Retrieves an employee by email

get
Authorizations
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}
200

OK

Updates an employee for a given email address

put
Authorizations
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}
200

OK

Deletes an employee for a given email address

delete
Authorizations
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}
200

OK

Invite an employee

post
Authorizations
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
200

OK

Retrieves all the employees

get
Authorizations
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
200

OK

Last updated

Was this helpful?