v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Interview API:Interviews

Find interviews

get/interviews

Query parameters

InterviewIdinteger[]
JobIdinteger[]
UserIdinteger[]

User Id - search for internal/user interviewers

ContactIdinteger[]

Contact Id - search for external/contact interviewers

CandidateIdinteger[]

Candidate Id - search for interviewees by candidateId

ApplicationIdinteger[]

Application Id - search for interviewees by applicationId

TypeInterviewType[]
StartAtstring[]

Search for interviews starting at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

EndAtstring[]

Search for interviews ending at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Locationstring
CreatedByinteger[]

User Id - search for interviews created by the specified user(s)

CreatedAtstring[]

Search for interviews created at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

UpdatedAtstring[]

Search for interviews updated at a specific date and time (UTC assumed, ISO date-time). Prefix with < or > to search dates before or after (inclusive) the specified date and time. Specify multiple times to search for a range.

Embedstring[]

Embed related resources.<br /> Resources available to embed are: self, evaluations

Offsetinteger

The index of the first entry to return from the resource collection

Limitinteger

The maximum number of entries to return.<br /> Setting to 0 will return only the total count of matching resources.

Response

List of interviews matching the specified criteria

totalCountinteger required