Interviews
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.
Properties

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

applicationUUID
Optional
The application being interviewed.
The Application object
The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.
Properties

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

candidateUUID
Optional
The candidate applying.

jobUUID
Optional
The job being applied for.

applied_atDateTime (ISO 8601)
Optional
When the application was submitted.

rejected_atDateTime (ISO 8601)
Optional
When the application was rejected.

sourceString
Optional
The application's source.

credited_toUUID
Optional
The user credited for this application.

current_stageUUID
Optional
The application's current stage.

reject_reasonUUID
Optional
The application's reason for rejection.

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

job_interview_stageUUID
Optional
The stage of the interview.

organizerUUID
Optional
The user organizing the interview.

interviewersArray
Required
Array of RemoteUser IDs.

locationString
Optional
The interview's location.

start_atDateTime (ISO 8601)
Optional
When the interview was started.

end_atDateTime (ISO 8601)
Optional
When the interview was ended.

remote_created_atDateTime (ISO 8601)
Optional
When the third party's interview was created.

remote_updated_atDateTime (ISO 8601)
Optional
When the third party's interview was updated.

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

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/interviews

https://api.merge.dev/api/ats/v1/interviews

US
EU

Returns a list of ScheduledInterview objects.


Query & Path Parameters

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

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
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_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

job_idString
Optional
If provided, wll only return interviews organized for this job.

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

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

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

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

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

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Fountain
Fountain
Greenhouse
Greenhouse
Lever
Lever
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Tellent
Tellent
Workday
Workday
Zoho Recruit
Zoho Recruit
POST
/interviews
Beta

https://api.merge.dev/api/ats/v1/interviews

US
EU

Creates a ScheduledInterview object with the given values.


Query & Path Parameters

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

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

modelObject
Required
Find available fields below under “Model Parameters”.

remote_user_idString
Required
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.

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

job_interview_stageUUID
The stage of the interview. Must pass in a valid Merge ID, which can be obtained from the id field in the JobInterviewStage object.

organizerUUID
The user organizing the interview. Must pass in a valid Merge ID, which can be obtained from the id field in the RemoteUser object.

interviewersArray
Array of RemoteUser IDs.

locationString
The interview's location.

start_atDateTime (ISO 8601)
When the interview was started.

end_atDateTime (ISO 8601)
When the interview was ended.

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

integration_paramsObject

linked_account_paramsObject

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Greenhouse
Greenhouse
Lever
Lever
Tellent
Tellent
Not seeing an integration that you're looking for? Submit a request for it.
To include the correct model fields when making POST requests, use the GET /interviews/meta/post endpoint. Learn more in our /meta guide.
GET
/interviews/{id}

https://api.merge.dev/api/ats/v1/interviews/{id}

US
EU

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.

idUUID
Required

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

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Fountain
Fountain
Greenhouse
Greenhouse
Lever
Lever
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
SAP SuccessFactors
SAP SuccessFactors
SmartRecruiters
SmartRecruiters
Tellent
Tellent
Workday
Workday
Zoho Recruit
Zoho Recruit
GET
/interviews/meta/post

https://api.merge.dev/api/ats/v1/interviews/meta/post

US
EU

Returns metadata for ScheduledInterview POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Fountain
Fountain
Greenhouse
Greenhouse
Lever
Lever
Oracle Taleo
Oracle Taleo