Appearance

Get Interviews ​

Endpoint ​

http
GET /unified/ats/interviews/{id}
Integrations supported
  • Ceipal

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

id
string
REQUIRED · 

The interview's unique identifier

Supported in
  • Ceipal
application
object

The interview's application

Supported in
  • Ceipal
id
string

Unique identifier of the application

candidate
object

The interview's candidate

Supported in
  • Ceipal
id
string

Unique identifier of the candidate

job_interview_stage
object

The interview's job interview stage

Supported in
  • Ceipal
id
string

Unique identifier of the job_interview_stage

organizer
object

The interview's organizer

Supported in
  • Ceipal
id
string

Unique identifier of the user

interviewers
object[]

The interview's interviewers

Supported in
  • Ceipal
id
string

Unique identifier of the user

location
string

The interview's location

Supported in
  • Ceipal
start_at
string · date-time

The interview's start date

end_at
string · date-time

The interview's end date

status
string

The interview's status

All possible enum values:
  • draft
  • scheduled
  • cancelled
  • awaiting_feedback
  • completed
created_at
string · date-time

The date and time of the interview's creation

Supported in
  • Ceipal
updated_at
string · date-time

The date and time of the interview's last update

Supported in
  • Ceipal
remote_data
object

Raw data returned from the remote API call.