Appearance

List Interviews ​

Endpoint ​

http
GET /unified/ats/interviews
Integrations supported
  • Ashby
  • Ceipal
  • Fountain
  • Greenhouse

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_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
candidate_id
string

The ID of the application to filter the interviews by.

Required in
  • Fountain
application_id
string

The ID of the application to filter the interviews by.

Supported in
  • Ashby
  • Greenhouse
created_at
string · date-time

The date and time of the interview's creation

Supported in
  • Ashby
  • Greenhouse
updated
Supported in
  • Greenhouse
start_at
string · date-time

The interview's start date

Supported in
  • Greenhouse
end_at
string · date-time

The interview's end date

Supported in
  • Greenhouse
job_interview_stage_id
string

The ID of the job interview stage to filter the interviews by.

Supported in
  • Ashby

Response Body ​

result
object[]

List of Interviews

id
string
REQUIRED · 

The interview's unique identifier

Supported in
  • Ashby
  • Ceipal
  • Fountain
  • Greenhouse
application
object

The interview's application

Supported in
  • Ashby
  • Ceipal
  • Greenhouse
id
string

Unique identifier of the application

candidate
object

The interview's candidate

Supported in
  • Ceipal
  • Fountain
id
string

Unique identifier of the candidate

job_interview_stage
object

The interview's job interview stage

Supported in
  • Ashby
  • Ceipal
  • Fountain
id
string

Unique identifier of the job_interview_stage

organizer
object

The interview's organizer

Supported in
  • Ceipal
  • Greenhouse
id
string

Unique identifier of the user

interviewers
object[]

The interview's interviewers

Supported in
  • Ashby
  • Ceipal
  • Fountain
  • Greenhouse
id
string

Unique identifier of the user

location
string

The interview's location

Supported in
  • Ashby
  • Ceipal
  • Fountain
  • Greenhouse
start_at
string · date-time

The interview's start date

Supported in
  • Ashby
  • Greenhouse
end_at
string · date-time

The interview's end date

Supported in
  • Ashby
  • Fountain
  • Greenhouse
status
string

The interview's status

All possible enum values:
  • draft
  • scheduled
  • cancelled
  • awaiting_feedback
  • completed
Supported in
  • Ashby
  • Fountain
  • Greenhouse
created_at
string · date-time

The date and time of the interview's creation

Supported in
  • Ashby
  • Ceipal
  • Greenhouse
updated_at
string · date-time

The date and time of the interview's last update

Supported in
  • Ceipal
  • Greenhouse
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.