{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/culture-amp/json-schema/culture-amp-survey-resps-response-schema.json",
  "title": "SurveyRespsResponse",
  "description": "container object for multiple Survey Responses",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/culture-amp-surveys-api-openapi.yml#/components/schemas/SurveyRespsResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SurveyResp"
      }
    },
    "pagination": {
      "$ref": "#/$defs/PaginationV2"
    }
  },
  "required": [
    "data"
  ],
  "$defs": {
    "PaginationV2": {
      "title": "Pagination",
      "type": "object",
      "properties": {
        "nextPath": {
          "type": "string",
          "description": "the relative url for the next page of data"
        }
      }
    },
    "SurveyResp": {
      "title": "SurveyResponse",
      "type": "object",
      "description": "The Survey Response record",
      "properties": {
        "id": {
          "type": "string",
          "description": "the identifier used by Culture Amp to identify the Survey"
        },
        "employeeId": {
          "type": "string",
          "description": "The unique employee ID"
        },
        "answers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SurveyRespAnswer"
          }
        },
        "rdeEnabled": {
          "type": "boolean",
          "description": "Identifies whether a survey was launched with `raw data extract` enabled (true/false)."
        },
        "captureLocale": {
          "type": "string",
          "description": "The the locale in which capture was completed"
        },
        "surveySubmittedBy": {
          "type": "string",
          "description": "The ID of the employee who submitted this response"
        },
        "startedAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date the Survey response was started",
          "format": "date-time"
        },
        "submittedAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date the Survey response was submitted",
          "format": "date-time"
        },
        "expiredAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date the Survey response expires",
          "format": "date-time"
        },
        "createdAt": {
          "type": "string",
          "description": "The date the Survey response was created",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "description": "The date the Survey response was last updated",
          "format": "date-time"
        },
        "processedAt": {
          "type": "string",
          "description": "The date the survey response was last processed by the public API. This can be used by consumers to determine if the response has been updated since the last time it was retrieved.",
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "processedAt",
        "rdeEnabled"
      ]
    },
    "SurveyRespAnswer": {
      "type": "object",
      "properties": {
        "questionId": {
          "type": "string",
          "description": "the id of the question being answered"
        },
        "textValue": {
          "type": "string",
          "description": "The comment left for a free text style question, or the answer a user left when the \"other\" option is picked on a select question"
        },
        "ratingScore": {
          "type": "integer",
          "description": "The rating in the range 1..5 or -1 if it was not answered"
        },
        "selectOptions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SurveyRespAnswerSelectOption"
          }
        },
        "answered": {
          "type": "boolean",
          "description": "Whether or not this answer was completed"
        },
        "additionalComment": {
          "type": "string",
          "description": "the comment text left against select questions as an additional input to the option chosen"
        },
        "mandatory": {
          "type": "boolean",
          "description": "Whether or not the question was made mandatory"
        },
        "createdAt": {
          "type": "string",
          "description": "The date the answer was created",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "description": "The date the answer was last updated",
          "format": "date-time"
        }
      },
      "required": [
        "answered",
        "mandatory"
      ]
    },
    "SurveyRespAnswerSelectOption": {
      "title": "SurveyResponseAnswerSelectOption",
      "type": "object",
      "description": "A chosen select option in a survey response answer",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of a select option chosen as part of the response"
        },
        "label": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "The localised label of a select option chosen as part of the response"
        }
      }
    }
  }
}