Characteristics Resource
get
Authorizations
SessionIdstringRequired
SessionId
Path parameters
characteristicIdstringRequiredExample:
64f8a0e2d5b7c9a1e3f4a5b6Responses
200
OK
*/*
or
or
get/api/v1/company/characteristics/{characteristicId}
GET /api/v1/company/characteristics/{characteristicId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200
OK
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"privated": true,
"isCore": true,
"employeeCount": 1,
"core": true,
"questionType": "DATE",
"ranges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
],
"deletedRanges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
]
}put
Authorizations
SessionIdstringRequired
SessionId
Path parameters
characteristicIdstringRequiredExample:
64f8a0e2d5b7c9a1e3f4a5b6Body
or
or
Responses
200
OK
*/*
or
or
put/api/v1/company/characteristics/{characteristicId}
PUT /api/v1/company/characteristics/{characteristicId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 500
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"privated": true,
"isCore": true,
"employeeCount": 1,
"core": true,
"questionType": "DATE",
"ranges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
],
"deletedRanges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
]
}200
OK
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"privated": true,
"isCore": true,
"employeeCount": 1,
"core": true,
"questionType": "DATE",
"ranges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
],
"deletedRanges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
]
}delete
Authorizations
SessionIdstringRequired
SessionId
Path parameters
characteristicIdstringRequiredExample:
64f8a0e2d5b7c9a1e3f4a5b6Responses
200
OK
*/*
or
or
delete/api/v1/company/characteristics/{characteristicId}
DELETE /api/v1/company/characteristics/{characteristicId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200
OK
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"privated": true,
"isCore": true,
"employeeCount": 1,
"core": true,
"questionType": "DATE",
"ranges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
],
"deletedRanges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
]
}get
Authorizations
SessionIdstringRequired
SessionId
Responses
200
OK
*/*
or
or
get/api/v1/company/characteristics
GET /api/v1/company/characteristics HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200
OK
[
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"privated": true,
"isCore": true,
"employeeCount": 1,
"core": true,
"questionType": "DATE",
"ranges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
],
"deletedRanges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
]
}
]post
Authorizations
SessionIdstringRequired
SessionId
Body
or
or
Responses
200
OK
*/*
or
or
post/api/v1/company/characteristics
POST /api/v1/company/characteristics HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 638
{
"segmentKey": {
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"companyId": "64f8a0e2d5b7c9a1e3f4a5b6"
},
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"createdOn": "2026-01-01T00:00:00.000Z",
"updatedOn": "2026-01-01T00:00:00.000Z",
"coreId": "64f8a0e2d5b7c9a1e3f4a5b6",
"privated": true,
"allActiveOptionIds": [
"64f8a0e2d5b7c9a1e3f4a5b6"
],
"questionType": "DATE",
"ranges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text"
}
],
"deletedRanges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text"
}
]
}200
OK
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"privated": true,
"isCore": true,
"employeeCount": 1,
"core": true,
"questionType": "DATE",
"ranges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
],
"deletedRanges": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"from": 1,
"fromType": "DAY",
"to": 1,
"toType": "DAY",
"name": "text",
"employeeCount": 1
}
]
}get
Authorizations
SessionIdstringRequired
SessionId
Path parameters
characteristicIdstringRequiredExample:
64f8a0e2d5b7c9a1e3f4a5b6Responses
200
OK
*/*
Summary of a single TREE segment configuration snapshot
versioninteger · int32Optional
Monotonically increasing version per segment; first snapshot is version 1.
changedOnstring · date-timeOptional
When the change was recorded.
changedBystringOptionalExample:
User that performed the change; null for system-triggered changes.
64f8a0e2d5b7c9a1e3f4a5b6changeTypestring · enumOptionalPossible values:
What caused this snapshot.
descriptionstringOptional
Optional human-authored note attached to the change.
get/api/v1/company/characteristics/{characteristicId}/history
GET /api/v1/company/characteristics/{characteristicId}/history HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200
OK
[
{
"version": 1,
"changedOn": "2026-01-01T00:00:00.000Z",
"changedBy": "64f8a0e2d5b7c9a1e3f4a5b6",
"changeType": "CREATE",
"description": "text"
}
]get
Authorizations
SessionIdstringRequired
SessionId
Path parameters
characteristicIdstringRequiredExample:
64f8a0e2d5b7c9a1e3f4a5b6versioninteger · int32Required
Responses
200
OK
*/*
Tree-based company segment (hierarchical / N levels). Employees are assigned to leaf nodes only; filters may target any level and the server expands parent selections to descendant leaves.
idstringOptionalExample:
64f8a0e2d5b7c9a1e3f4a5b6descriptionstringRequired
privatedbooleanOptional
isCorebooleanOptional
employeeCountinteger · int32Optional
corebooleanOptional
questionTypestring · enumRequiredPossible values:
Type of segmentation characteristic
get/api/v1/company/characteristics/{characteristicId}/history/{version}
GET /api/v1/company/characteristics/{characteristicId}/history/{version} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200
OK
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"description": "text",
"question": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"privated": true,
"isCore": true,
"employeeCount": 1,
"core": true,
"questionType": "DATE",
"rootNodes": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"value": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"position": 1,
"children": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"value": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"position": 1,
"children": "[Circular Reference]",
"employeeCount": 1
}
],
"employeeCount": 1
}
],
"deletedNodes": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"value": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"position": 1,
"children": [
{
"id": "64f8a0e2d5b7c9a1e3f4a5b6",
"value": {
"defaultValue": "Happy birthday!",
"langValues": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"valid": true
},
"position": 1,
"children": "[Circular Reference]",
"employeeCount": 1
}
],
"employeeCount": 1
}
]
}Last updated