v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Scheduled Interview

Get Scheduled Interview By Id

Returns a ScheduledInterview object with the given id.

get/api/ats/v1/scheduled-interviews/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Include raw data in the response

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring

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]

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.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required

remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

applicationstring nullable required

The identifier of the application associated with the interview.

job_interview_stagestring nullable required

The identifier of the interview stage associated with this interview.

organizerstring nullable required

The identifier of the user who organized the interview.

locationstring nullable required

The location where the interview is scheduled to take place.

start_atstring nullable required

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

end_atstring nullable required

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

remote_created_atstring nullable required

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

remote_updated_atstring nullable required

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

status'SCHEDULED' | 'AWAITING_FEEDBACK' | 'COMPLETE' nullable 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.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "application": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "job_interview_stage": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "organizer": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "location": "123 Main St, Anytown, USA",
  "start_at": "2021-01-01T00:00:00Z",
  "end_at": "2021-01-01T00:00:00Z",
  "remote_created_at": "2021-01-01T00:00:00Z",
  "remote_updated_at": "2021-01-01T00:00:00Z",
  "status": "SCHEDULED"
}