{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/culture-amp/json-schema/culture-amp-surveys-response-schema.json",
  "title": "SurveysResponse",
  "description": "container object for multiple Surveys",
  "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/SurveysResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Survey"
      }
    },
    "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"
        }
      }
    },
    "Survey": {
      "title": "Survey",
      "type": "object",
      "description": "The Survey record",
      "properties": {
        "id": {
          "type": "string",
          "description": "the identifier used by Culture Amp to identify the Survey"
        },
        "name": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "The locale informed name of the Survey"
        },
        "status": {
          "type": "string",
          "description": "The status of the survey.\nSurveys that are still being drafted are not surfaced in the API.\nFor more information about draft surveys, please refer to the following support guide: https://support.cultureamp.com/en/articles/7048518-surveys-and-programs-page#h_71149c7700\n"
        },
        "rdeEnabled": {
          "type": "boolean",
          "description": "A boolean describing the RDE Enabled status of the survey"
        },
        "owner": {
          "type": "string",
          "description": "The Culture Amp ID identifying the user who owns the Survey"
        },
        "workflow": {
          "type": "string",
          "description": "The workflow of the survey"
        },
        "launchedAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date the Survey was launched",
          "format": "date-time"
        },
        "closedAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date the Survey was closed",
          "format": "date-time"
        },
        "createdAt": {
          "type": "string",
          "description": "The date the Survey was created",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "description": "The date the Survey was last updated",
          "format": "date-time"
        },
        "processedAt": {
          "type": "string",
          "description": "The date the survey was last processed by the public API. This can be used by consumers to determine if the survey has been updated since the last time it was retrieved.",
          "format": "date-time"
        },
        "communicatedClosedAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "The timestamp when the closure of the survey was communicated.",
          "format": "date-time"
        },
        "surveyDueDays": {
          "type": "integer",
          "description": "How many days from survey launch that the survey is due."
        },
        "kioskModeEnabled": {
          "type": "boolean",
          "description": "Indicates whether the survey is being run in kiosk mode."
        },
        "excludeParticipantsAfter": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date at which this survey will no longer include participants.",
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "processedAt",
        "rdeEnabled"
      ]
    }
  }
}