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

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.

GEThttps://api.myhappyforce.com/api/v1/public/company/characteristics

Response

200400

OK

Body

*/*

idstring

typeenum

DATELISTBOOLEAN

namestring

allowedValuesarray of ProfileValue (object)

Request

JavaScriptCurl

const response = await fetch('https://api.myhappyforce.com/api/v1/public/company/characteristics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "type": "DATE",
    "name": "text",
    "allowedValues": [
      {
        "id": "text",
        "label": "text"
      }
    ]
  }
]