Merge · Schema

ScheduledInterview

# The ScheduledInterview Object ### Description The `ScheduledInterview` object is used to represent a scheduled interview for a given candidate’s application to a job. An `Application` can have multiple `ScheduledInterview`s depending on the particular hiring process. ### Usage Example Fetch from the `LIST ScheduledInterviews` endpoint and filter by `interviewers` to show all office locations.

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.
application	stringnull	The application being interviewed.
job_interview_stage	stringnull	The stage of the interview.
organizer	stringnull	The user organizing the interview.
interviewers	array	Array of `RemoteUser` IDs.
location	stringnull	The interview's location.
start_at	stringnull	When the interview was started.
end_at	stringnull	When the interview was ended.
remote_created_at	stringnull	When the third party's interview was created.
remote_updated_at	stringnull	When the third party's interview was updated.
status	object	The interview's status.
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
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScheduledInterview",
  "title": "ScheduledInterview",
  "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."
    },
    "application": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The application being interviewed."
    },
    "job_interview_stage": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The stage of the interview."
    },
    "organizer": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The user organizing the interview."
    },
    "interviewers": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Array of `RemoteUser` IDs."
    },
    "location": {
      "type": [
        "string",
        "null"
      ],
      "description": "The interview's location."
    },
    "start_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the interview was started."
    },
    "end_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the interview was ended."
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's interview was created."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's interview was updated."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ScheduledInterviewStatusEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The interview's status."
    },
    "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/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ScheduledInterviewFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The ScheduledInterview Object\n### Description\nThe `ScheduledInterview` object is used to represent a scheduled interview for a given candidate\u2019s application to a job. An `Application` can have multiple `ScheduledInterview`s depending on the particular hiring process.\n### Usage Example\nFetch from the `LIST ScheduledInterviews` endpoint and filter by `interviewers` to show all office locations."
}