Skip to main content
GET
Get Scheduled Interview By Id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

Include raw data in the response

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The AtsScheduledInterview object represents an interview event scheduled within the ATS.

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
application
any | null
required

The identifier of the application associated with the interview.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

job_interview_stage
any | null
required

The identifier of the interview stage associated with this interview.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

organizer
any | null
required

The identifier of the user who organized the interview.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

interviewers
any[] | null
required

A list of identifiers for the users who are scheduled to interview the candidate.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

location
string | null
required

The location where the interview is scheduled to take place.

Example:

"123 Main St, Anytown, USA"

start_at
string | null
required

The ISO date string when the interview is scheduled to start.

Example:

"2021-01-01T00:00:00Z"

end_at
string | null
required

The ISO date string when the interview is scheduled to end.

Example:

"2021-01-01T00:00:00Z"

remote_created_at
string | null
required

The ISO date string when the interview was created in the remote system.

Example:

"2021-01-01T00:00:00Z"

remote_updated_at
string | null
required

The ISO date string when the interview was last updated in the remote system.

Example:

"2021-01-01T00:00:00Z"

status
enum<string>
required

The current status of the scheduled interview. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
SCHEDULED,
AWAITING_FEEDBACK,
COMPLETE
Example:

"SCHEDULED"

raw_data
Raw Data · object | null

This is the Raw data

Example: