Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Survey Feedback Resource

get
Authorizations
SessionIdstringRequired

SessionId

Path parameters
surveyIdstringRequiredExample: 64f8a0e2d5b7c9a1e3f4a5b6
Query parameters
roundIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
fromstring · date-timeOptional
tostring · date-timeOptional
fromCommentinteger · int32OptionalDefault: 0
toCommentinteger · int32OptionalDefault: 1
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
filtersstringOptional
groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
questionIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
questionResultsstringOptional
Responses
200

OK

*/*
frominteger · int32Optional
tointeger · int64Optional
totalinteger · int64Optional
get/api/v1/company/feedback/surveys/{surveyId}
GET /api/v1/company/feedback/surveys/{surveyId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

{
  "from": 1,
  "to": 1,
  "total": 1,
  "result": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "feedbackType": "RECOGNITION",
      "feedbackTypeImage": "text",
      "privated": true,
      "date": "2026-01-01T00:00:00.000Z",
      "comment": "text",
      "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "hierarchyName": "text",
      "hierarchyAnonymized": true,
      "flaggedAnonymous": true,
      "votes": [
        {
          "id": 1,
          "score": 1,
          "label": {
            "defaultValue": "Happy birthday!",
            "langValues": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "valid": true
          },
          "imageUrl": "text",
          "color": "text"
        }
      ],
      "attachments": [
        {
          "type": "IMAGE",
          "fileURL": "text"
        }
      ],
      "allowStartConversation": true,
      "conversationOwnerId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "signerId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "conversationId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "hasBeenSeen": true,
      "allowPrivatedSwap": true,
      "value": {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "name": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "iconImagePath": "text"
      },
      "target": {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "name": "text",
        "type": "EMPLOYEE"
      },
      "hrRelevant": true,
      "hrTags": [
        "text"
      ],
      "sentimentScore": {
        "agreement": true,
        "ironic": true,
        "subjective": true,
        "score": 1,
        "positivity": 1
      },
      "entities": [
        {
          "form": "text",
          "relevance": 1,
          "type": "text"
        }
      ],
      "concepts": [
        {
          "form": "text",
          "relevance": 1,
          "type": "text"
        }
      ],
      "emotions": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "personalities": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "personas": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "announcementId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "replies": [
        {
          "id": "64f8a0e2d5b7c9a1e3f4a5b6",
          "feedbackType": "RECOGNITION",
          "feedbackTypeImage": "text",
          "privated": true,
          "date": "2026-01-01T00:00:00.000Z",
          "comment": "text",
          "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "hierarchyName": "text",
          "hierarchyAnonymized": true,
          "flaggedAnonymous": true,
          "votes": [
            {
              "id": 1,
              "score": 1,
              "label": {
                "defaultValue": "Happy birthday!",
                "langValues": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "valid": true
              },
              "imageUrl": "text",
              "color": "text"
            }
          ],
          "attachments": [
            {
              "type": "IMAGE",
              "fileURL": "text"
            }
          ],
          "allowStartConversation": true,
          "conversationOwnerId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "signerId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "conversationId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "hasBeenSeen": true,
          "allowPrivatedSwap": true,
          "hrRelevant": true,
          "hrTags": [
            "text"
          ],
          "sentimentScore": {
            "agreement": true,
            "ironic": true,
            "subjective": true,
            "score": 1,
            "positivity": 1
          },
          "entities": [
            {
              "form": "text",
              "relevance": 1,
              "type": "text"
            }
          ],
          "concepts": [
            {
              "form": "text",
              "relevance": 1,
              "type": "text"
            }
          ],
          "emotions": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "personalities": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "personas": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "announcementId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "clusters": [
            {
              "title": "text",
              "score": 1
            }
          ],
          "hrPositivenessClassification": "POSITIVE",
          "replied": true,
          "allowReply": true,
          "allowNonAnonymousReply": true,
          "originalPrivated": true,
          "privateStatusChangedById": "64f8a0e2d5b7c9a1e3f4a5b6",
          "privateStatusChangedOn": "2026-01-01T00:00:00.000Z",
          "allowTypeSwap": true,
          "likes": 1,
          "dislikes": 1,
          "inappropriate": true,
          "inappropriates": 1,
          "employeeInnappropiateFeedback": [
            {
              "date": "2026-01-01T00:00:00.000Z",
              "type": "THRESHOLD",
              "reason": "text"
            }
          ],
          "inappropriateReasonType": "THRESHOLD",
          "inappropriateSourceType": "EMPLOYEES",
          "commentRefereed": {
            "userId": "64f8a0e2d5b7c9a1e3f4a5b6",
            "date": "2026-01-01T00:00:00.000Z"
          },
          "inappropriateReason": "text",
          "statuses": [
            {
              "statusTypeId": "64f8a0e2d5b7c9a1e3f4a5b6",
              "date": "2026-01-01T00:00:00.000Z",
              "userId": "64f8a0e2d5b7c9a1e3f4a5b6",
              "current": true
            }
          ],
          "container": {
            "id": "64f8a0e2d5b7c9a1e3f4a5b6",
            "title": {
              "defaultValue": "Happy birthday!",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            }
          },
          "refereed": {
            "userId": "64f8a0e2d5b7c9a1e3f4a5b6",
            "date": "2026-01-01T00:00:00.000Z"
          }
        }
      ],
      "clusters": [
        {
          "title": "text",
          "score": 1
        }
      ],
      "hrPositivenessClassification": "POSITIVE",
      "replied": true,
      "allowReply": true,
      "allowNonAnonymousReply": true,
      "originalPrivated": true,
      "privateStatusChangedById": "64f8a0e2d5b7c9a1e3f4a5b6",
      "privateStatusChangedOn": "2026-01-01T00:00:00.000Z",
      "allowTypeSwap": true,
      "likes": 1,
      "dislikes": 1,
      "inappropriate": true,
      "inappropriates": 1,
      "employeeInnappropiateFeedback": [
        {
          "date": "2026-01-01T00:00:00.000Z",
          "type": "THRESHOLD",
          "reason": "text"
        }
      ],
      "inappropriateReasonType": "THRESHOLD",
      "inappropriateSourceType": "EMPLOYEES",
      "commentRefereed": {
        "userId": "64f8a0e2d5b7c9a1e3f4a5b6",
        "date": "2026-01-01T00:00:00.000Z"
      },
      "inappropriateReason": "text",
      "statuses": [
        {
          "statusTypeId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "date": "2026-01-01T00:00:00.000Z",
          "userId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "current": true
        }
      ],
      "container": {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "title": {
          "defaultValue": "Happy birthday!",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        }
      },
      "refereed": {
        "userId": "64f8a0e2d5b7c9a1e3f4a5b6",
        "date": "2026-01-01T00:00:00.000Z"
      },
      "questionId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "questionType": "GENERAL",
      "surveyId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "roundId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "questionTitle": {
        "defaultValue": "Happy birthday!",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      }
    }
  ]
}

Last updated