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 5 months ago

Was this helpful?

Deletes an employee for a given email address

delete
Authorizations
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
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": {
      "timestamp": 1,
      "date": "2025-06-23T06:22:43.628Z"
    },
    "profile": [
      {
        "id": {
          "timestamp": 1,
          "date": "2025-06-23T06:22:43.628Z"
        },
        "date": "2025-06-23T06:22:43.628Z",
        "valueId": {
          "timestamp": 1,
          "date": "2025-06-23T06:22:43.628Z"
        }
      }
    ],
    "groupIds": [
      {
        "timestamp": 1,
        "date": "2025-06-23T06:22:43.628Z"
      }
    ]
  }
]
  • 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
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": {
    "timestamp": 1,
    "date": "2025-06-23T06:22:43.628Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-06-23T06:22:43.628Z"
      },
      "date": "2025-06-23T06:22:43.628Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-06-23T06:22:43.628Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-06-23T06:22:43.628Z"
    }
  ]
}

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

put
Authorizations
Body

The details of the employee you want to invite to Happyforce

namestringOptional

Name of the employee

emailstringOptional

Email of the employee

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

{
  "name": "text",
  "email": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-06-23T06:22:43.628Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-06-23T06:22:43.628Z"
      },
      "date": "2025-06-23T06:22:43.628Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-06-23T06:22:43.628Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-06-23T06:22:43.628Z"
    }
  ]
}
{
  "name": "text",
  "email": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-06-23T06:22:43.628Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-06-23T06:22:43.628Z"
      },
      "date": "2025-06-23T06:22:43.628Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-06-23T06:22:43.628Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-06-23T06:22:43.628Z"
    }
  ]
}