Employees

Retrieves all the employees

get
Authorizations
Query parameters
hierarchyIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
profilestringOptional
groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
activatedbooleanOptional
deletedbooleanOptional
Responses
200

OK

*/*
get
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-09-15T19:37:32.956Z",
        "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
      }
    ],
    "groupIds": [
      "64f8a0e2d5b7c9a1e3f4a5b6"
    ],
    "role": "ADVISOR",
    "managedHierarchies": [
      "64f8a0e2d5b7c9a1e3f4a5b6"
    ]
  }
]

Last updated

Was this helpful?