API Reference

List Interviews

get
https://{subdomain}.pinpointhq.com/api/v1/interviews
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
include
array of strings

Include related resources

fields[interviews]
array of objects

Include only specified fields of Interview in response

fields[stages]
array of objects

Include only specified fields of Stage in response

fields[interview_parts]
array of objects

Include only specified fields of Interview Part in response

fields[applications]
array of objects

Include only specified fields of Application in response

fields[job_seekers]
array of objects

Include only specified fields of Job Seeker in response

date-time

Filter records with start_at greater than this value

date-time

Filter records with start_at less than this value

string

Filter records by Interviewable id

filter[interviewable_type]
array of strings

Filter records by Interviewable type

filter[interviewable_type]
date-time

Filter records with created_at greater than this value

date-time

Filter records with created_at less than this value

date-time

Filter records with updated_at greater than this value

date-time

Filter records with updated_at less than this value

filter[presence]
array of strings

Filter records with presence equal to this value

filter[job_visibility]
array of strings

Filter records with job_visibility equal to this value

sort
array of strings

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

integer
Defaults to 1

The page number of records to return

integer
0 to 1000
Defaults to 100

The number of records to return

string
enum

Include the total number of matched records within the meta key of the response object.

Allowed:
Responses

Updated 1 day ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 1 day ago