Interviews
TheScheduledInterview 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.The ScheduledInterview object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
applicationStringOptional
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.
JSON
{"id": "92e8a369-fffe-430d-b93a-f7e8a16563f1","remote_id": "98796","candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef","job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","applied_at": "2021-10-15T00:00:00Z","rejected_at": "2021-11-15T00:00:00Z","source": "Campus recruiting event","credited_to": "58166795-8d68-4b30-9bfb-bfd402479484","current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea","reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784","remote_data": [{"path": "/candidacies","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
candidateStringOptional
The candidate applying.
jobStringOptional
The job being applied for.
applied_atStringOptional
When the application was submitted.
rejected_atStringOptional
When the application was rejected.
sourceStringOptional
The application's source.
credited_toStringOptional
The user credited for this application.
current_stageStringOptional
The application's current stage.
reject_reasonStringOptional
The application's reason for rejection.
remote_dataRemoteData[]Optional
remote_was_deletedBooleanRequired
field_mappingsObjectOptional
job_interview_stageStringOptional
The stage of the interview.
organizerStringOptional
The user organizing the interview.
interviewersArrayRequired
Array of
RemoteUser IDs.locationStringOptional
The interview's location.
start_atStringOptional
When the interview was started.
end_atStringOptional
When the interview was ended.
remote_created_atStringOptional
When the third party's interview was created.
remote_updated_atStringOptional
When the third party's interview was updated.
statusEnumOptional
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
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
The ScheduledInterview object
JSON
{"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"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
GET
/interviews
Returns a list of ScheduledInterview objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
application_idStringOptional
If provided, will only return interviews for this application.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
job_interview_stage_idStringOptional
If provided, will only return interviews at this stage.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
organizer_idStringOptional
If provided, will only return interviews organized by this user.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"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"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}
Field support by platform
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringstatusEnum
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringstatusEnum
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstart_atStringstatusEnum
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atString
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstart_atString
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstart_atString
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringstatusEnum
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_idStringstart_atString
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atString
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/interviews/{id}
Returns a ScheduledInterview object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"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"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Field support by platform
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringstatusEnumFountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringstatusEnumGreenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstart_atStringstatusEnumLever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringOracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstart_atStringRecruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringorganizerStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstart_atStringSAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringstatusEnumSmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayjob_interview_stageStringlocationStringorganizerStringremote_created_atStringremote_idStringstart_atStringWorkable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringWorkday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_dataarrayremote_was_deletedbooleanfield_mappingsobjectend_atStringinterviewersArrayremote_dataRemoteData[]pathstringdataobjectremote_idStringstart_atStringHint: Use the /linked-accounts endpoint to pull platform support information.