Interviews

The ScheduledInterview object is used to represent an interview

The ScheduledInterview object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

applicationString
Optional
The application being interviewed.

job_interview_stageString
Optional
The stage of the interview.

organizerString
Optional
The user organizing the interview.

interviewersArray
Optional
Array of RemoteUser IDs.

locationString
Optional
The interview's location.

start_atString
Optional
When the interview was started.

end_atString
Optional
When the interview was ended.

remote_created_atString
Optional
When the third party's interview was created.

remote_updated_atString
Optional
When the third party's interview was updated.

statusEnum
Optional
The interview's status. Possible values include: SCHEDULED, AWAITING_FEEDBACK, COMPLETE, or - in cases where there is no clear mapping - the original value passed through.

remote_dataRemoteData[]
Optional

The ScheduledInterview object

{
  "id": "b8faf072-98b9-4445-8a9a-6b4950efca19",
  "remote_id": "3",
  "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_data": [
    {
      "path": "/interviews",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/interviews

Returns a list of ScheduledInterview objects.


Query & Path Parameters


application_idString
Optional
If provided, will only return interviews for this application.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

job_interview_stage_idString
Optional
If provided, will only return interviews at this stage.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

organizer_idString
Optional
If provided, will only return interviews organized by this user.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "b8faf072-98b9-4445-8a9a-6b4950efca19",
      "remote_id": "3",
      "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_data": [
        {
          "path": "/interviews",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

organizerString

applicationString

remote_updated_atString

remote_dataRemoteData[]

remote_created_atString

end_atString

remote_idString

statusEnum

interviewersArray

locationString

job_interview_stageString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

applicationString

remote_dataRemoteData[]

end_atString

interviewersArray

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

organizerString

applicationString

remote_dataRemoteData[]

remote_created_atString

end_atString

remote_idString

interviewersArray

locationString

job_interview_stageString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

organizerString

applicationString

remote_updated_atString

remote_dataRemoteData[]

remote_created_atString

end_atString

remote_idString

interviewersArray

job_interview_stageString

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

applicationString

statusEnum

interviewersArray

job_interview_stageString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

job_interview_stageString

applicationString

remote_dataRemoteData[]

end_atString

statusEnum

interviewersArray

remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

applicationString

remote_dataRemoteData[]

end_atString

remote_idString

statusEnum

interviewersArray

locationString

job_interview_stageString
POST

/interviews

BETA

Creates a ScheduledInterview object with the given values.


Query & Path Parameters


remote_user_idString
Optional
The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.

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

Body Parameters


remote_idString
Optional
The third-party API ID of the matching object.

applicationString
Optional
The application being interviewed. Must pass in a valid Merge ID, which can be obtained from the id field in the Application table.

job_interview_stageString
Optional
The stage of the interview. Must pass in a valid Merge ID, which can be obtained from the id field in the Job_interview_stage table.

organizerString
Optional
The user organizing the interview. Must pass in a valid Merge ID, which can be obtained from the id field in the Organizer table.

interviewersArray
Required
Array of RemoteUser IDs.

locationString
Optional
The interview's location.

start_atString
Optional
When the interview was started.

end_atString
Optional
When the interview was ended.

remote_created_atString
Optional
When the third party's interview was created.

remote_updated_atString
Optional
When the third party's interview was updated.

statusEnum
Optional
The interview's status. Must pass in one of the following choices: SCHEDULED, AWAITING_FEEDBACK, COMPLETE.

Response

{
  "id": "b8faf072-98b9-4445-8a9a-6b4950efca19",
  "remote_id": "3",
  "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_data": [
    {
      "path": "/interviews",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


start_atString
Required

organizerString
Required

applicationString
Required

remote_created_atString
Optional

end_atString
Required

locationString
Optional

remote_idString
Optional
GET

/interviews/{id}

Returns a ScheduledInterview object with the given id.


Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Response

{
  "id": "b8faf072-98b9-4445-8a9a-6b4950efca19",
  "remote_id": "3",
  "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_data": [
    {
      "path": "/interviews",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

organizerString

applicationString

remote_updated_atString

remote_dataRemoteData[]

remote_created_atString

end_atString

remote_idString

statusEnum

interviewersArray

locationString

job_interview_stageString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

applicationString

remote_dataRemoteData[]

end_atString

interviewersArray

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

organizerString

applicationString

remote_dataRemoteData[]

remote_created_atString

end_atString

remote_idString

interviewersArray

locationString

job_interview_stageString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

organizerString

applicationString

remote_updated_atString

remote_dataRemoteData[]

remote_created_atString

end_atString

remote_idString

interviewersArray

job_interview_stageString

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

applicationString

statusEnum

interviewersArray

job_interview_stageString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

job_interview_stageString

applicationString

remote_dataRemoteData[]

end_atString

statusEnum

interviewersArray

remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


start_atString

applicationString

remote_dataRemoteData[]

end_atString

remote_idString

statusEnum

interviewersArray

locationString

job_interview_stageString