/interviews

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.ats.interviews.create({
    isDebugMode: true,
    runAsync: true,
    model: {},
    remoteUserId: "remote_user_id"
});

{
  "model": {
    "id": "b8faf072-98b9-4445-8a9a-6b4950efca19",
    "remote_id": "3",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "application": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
    "job_interview_stage": "2f7adb59-3fe6-4b5b-aef6-563f72bd13dc",
    "organizer": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
    "interviewers": [
      "f9813dd5-e70b-484c-91d8-00acd6065b07",
      "89a86fcf-d540-4e6b-ac3d-ce07c4ec9b3c"
    ],
    "location": "Embarcadero Center 2",
    "start_at": "2021-10-15T00:00:00Z",
    "end_at": "2021-10-15T02:00:00Z",
    "remote_created_at": "2021-10-15T00:00:00Z",
    "remote_updated_at": "2021-10-15T00:00:00Z",
    "status": "SCHEDULED",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/interviews"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates a ScheduledInterview object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

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 ScheduledInterviews depending on the particular hiring process.

Usage Example

Fetch from the LIST ScheduledInterviews endpoint and filter by interviewers to show all office locations.

# 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.

remote_user_idstringRequired

Response

modelobject

Description

Usage Example

Fetch from the LIST ScheduledInterviews endpoint and filter by interviewers to show all office locations.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

applicationstring or nullRequiredformat: "uuid"

The application being interviewed.

interviewerslist of stringsRequired

Array of RemoteUser IDs.

start_atdatetime or nullRequired

When the interview was started.

end_atdatetime or nullRequired

When the interview was ended.

remote_idstring or nullOptional

The third-party API ID of the matching object.

organizerstring or nullOptionalformat: "uuid"

The user organizing the interview.

locationstring or nullOptional

The interview's location.

remote_created_atdatetime or nullOptional

When the third party's interview was created.

remote_updated_atdatetime or nullOptional

When the third party's interview was updated.

statusenum or nullOptional

The interview’s status.

SCHEDULED - SCHEDULED
AWAITING_FEEDBACK - AWAITING_FEEDBACK
COMPLETE - COMPLETE

Allowed values:

Supported POST model parameters

interviewerslist of stringsRequired

Array of RemoteUser IDs.

start_atdatetime or nullRequired

When the interview was started.

end_atdatetime or nullRequired

When the interview was ended.

remote_idstring or nullOptional

The third-party API ID of the matching object.

applicationstring or nullOptionalformat: "uuid"

The application being interviewed.

job_interview_stagestring or nullOptionalformat: "uuid"

The stage of the interview.

organizerstring or nullOptionalformat: "uuid"

The user organizing the interview.

locationstring or nullOptional

The interview's location.

remote_created_atdatetime or nullOptional

When the third party's interview was created.

Supported POST model parameters

start_atdatetime or nullRequired

When the interview was started.

end_atdatetime or nullRequired

When the interview was ended.

remote_idstring or nullOptional

The third-party API ID of the matching object.

job_interview_stagestring or nullOptionalformat: "uuid"

The stage of the interview.

locationstring or nullOptional

The interview's location.

remote_created_atdatetime or nullOptional

When the third party's interview was created.

remote_updated_atdatetime or nullOptional

When the third party's interview was updated.

Supported POST model parameters

applicationstring or nullRequiredformat: "uuid"

The application being interviewed.

interviewerslist of stringsRequired

Array of RemoteUser IDs.

start_atdatetime or nullRequired

When the interview was started.

end_atdatetime or nullRequired

When the interview was ended.

remote_idstring or nullOptional

The third-party API ID of the matching object.

organizerstring or nullOptionalformat: "uuid"

The user organizing the interview.

locationstring or nullOptional

The interview's location.

remote_created_atdatetime or nullOptional

When the third party's interview was created.

remote_updated_atdatetime or nullOptional

When the third party's interview was updated.

statusenum or nullOptional

The interview’s status.

SCHEDULED - SCHEDULED
AWAITING_FEEDBACK - AWAITING_FEEDBACK
COMPLETE - COMPLETE

Allowed values:

Supported POST model parameters

interviewerslist of stringsRequired

Array of RemoteUser IDs.

start_atdatetime or nullRequired

When the interview was started.

end_atdatetime or nullRequired

When the interview was ended.

remote_idstring or nullOptional

The third-party API ID of the matching object.

applicationstring or nullOptionalformat: "uuid"

The application being interviewed.

job_interview_stagestring or nullOptionalformat: "uuid"

The stage of the interview.

organizerstring or nullOptionalformat: "uuid"

The user organizing the interview.

locationstring or nullOptional

The interview's location.

remote_created_atdatetime or nullOptional

When the third party's interview was created.

Supported POST model parameters

start_atdatetime or nullRequired

When the interview was started.

end_atdatetime or nullRequired

When the interview was ended.

remote_idstring or nullOptional

The third-party API ID of the matching object.

job_interview_stagestring or nullOptionalformat: "uuid"

The stage of the interview.

locationstring or nullOptional

The interview's location.

remote_created_atdatetime or nullOptional

When the third party's interview was created.

remote_updated_atdatetime or nullOptional

When the third party's interview was updated.

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Description

Usage Example

Description

Usage Example

Field support by integration