Merge · Schema

ScreeningQuestion

# The ScreeningQuestion Object ### Description The `ScreeningQuestion` object is used to represent questions asked to screen candidates for a job. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
job	stringnull	The job associated with the screening question.
description	stringnull	The description of the screening question
title	stringnull	The title of the screening question
type	object	The data type for the screening question.
required	booleannull	Whether or not the screening question is required.
options	array
remote_was_deleted	boolean	Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScreeningQuestion",
  "title": "ScreeningQuestion",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "job": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The job associated with the screening question."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The description of the screening question"
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "The title of the screening question"
    },
    "type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ScreeningQuestionTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The data type for the screening question."
    },
    "required": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether or not the screening question is required."
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ScreeningQuestionOption"
      }
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    }
  },
  "description": "# The ScreeningQuestion Object\n### Description\nThe `ScreeningQuestion` object is used to represent questions asked to screen candidates for a job.\n\n### Usage Example\nTODO"
}