Employees

Retrieves an employee by email

get

Authorizations

Responses

200

OK

*/*

get

HTTPcURLJavaScriptPython

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

200

OK

{
  "name": "text",
  "email": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-07-14T13:25:45.922Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-07-14T13:25:45.922Z"
      },
      "date": "2025-07-14T13:25:45.922Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-07-14T13:25:45.922Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-07-14T13:25:45.922Z"
    }
  ]
}

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

*/*

put

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "email": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-07-14T13:25:45.922Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-07-14T13:25:45.922Z"
      },
      "date": "2025-07-14T13:25:45.922Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-07-14T13:25:45.922Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-07-14T13:25:45.922Z"
    }
  ]
}

200

OK

{
  "name": "text",
  "email": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-07-14T13:25:45.922Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-07-14T13:25:45.922Z"
      },
      "date": "2025-07-14T13:25:45.922Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-07-14T13:25:45.922Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-07-14T13:25:45.922Z"
    }
  ]
}

Deletes an employee for a given email address

delete

Authorizations

Responses

200

OK

*/*

Responsestring

delete

HTTPcURLJavaScriptPython

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

200

OK

text

Retrieves all the employees

get

Authorizations

Responses

200

OK

*/*

get

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "name": "text",
    "email": "text",
    "hierarchyId": {
      "timestamp": 1,
      "date": "2025-07-14T13:25:45.922Z"
    },
    "profile": [
      {
        "id": {
          "timestamp": 1,
          "date": "2025-07-14T13:25:45.922Z"
        },
        "date": "2025-07-14T13:25:45.922Z",
        "valueId": {
          "timestamp": 1,
          "date": "2025-07-14T13:25:45.922Z"
        }
      }
    ],
    "groupIds": [
      {
        "timestamp": 1,
        "date": "2025-07-14T13:25:45.922Z"
      }
    ]
  }
]