Characteristics

Operations related to characteristics (profile questions, such Gender, etc)

Retrieves all the personal profile metadata (eg: gender, age, tenure) and configuration available for your company

get

The information provided by this endpoint is useful to build the filters on the stats API or setup the employee profiles on the Employees API.

Authorizations
Responses
200
OK
*/*
get
GET /v1/public/company/characteristics HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*
[
  {
    "id": {
      "timestamp": 1,
      "date": "2025-06-27T12:10:20.683Z"
    },
    "type": "DATE",
    "name": "text",
    "allowedValues": [
      {
        "id": {
          "timestamp": 1,
          "date": "2025-06-27T12:10:20.683Z"
        },
        "label": "text"
      }
    ]
  }
]

Was this helpful?