Interviews

The ScheduledInterview object is used to represent an interview

The ScheduledInterview object

Properties


idString
Required

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

applicationString
Optional

job_interview_stageString
Optional

organizerString
Optional

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. Possible values include: SCHEDULED, AWAITING_FEEDBACK, COMPLETE, or - in cases where there is no clear mapping - the original value passed through.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

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_was_deleted": true
}

GET

/interviews

Returns a list of ScheduledInterview objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

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_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_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_fieldsString
Optional
Which fields should be returned in non-normalized form.

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

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_was_deleted": true
}
]
}
Field support by platform

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

remote_idString

start_atString

statusEnum

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

organizerString

remote_created_atString

remote_idString

remote_updated_atString

start_atString

statusEnum

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

organizerString

remote_created_atString

remote_idString

start_atString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

organizerString

remote_created_atString

remote_idString

remote_updated_atString

start_atString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

organizerString

remote_created_atString

remote_idString

remote_updated_atString

start_atString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

remote_idString

start_atString

statusEnum

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

remote_idString

start_atString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

remote_idString

start_atString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/interviews/{id}

Returns a ScheduledInterview object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

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.

remote_fieldsString
Optional
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_was_deleted": true
}
Field support by platform

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

remote_idString

start_atString

statusEnum

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

organizerString

remote_created_atString

remote_idString

remote_updated_atString

start_atString

statusEnum

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

organizerString

remote_created_atString

remote_idString

start_atString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

locationString

organizerString

remote_created_atString

remote_idString

remote_updated_atString

start_atString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

organizerString

remote_created_atString

remote_idString

remote_updated_atString

start_atString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

job_interview_stageString

remote_idString

start_atString

statusEnum

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

remote_idString

start_atString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

end_atString

interviewersArray

remote_idString

start_atString
Hint: Use the /linked-accounts endpoint to pull platform support information.