Skip to main content

Interview schedule API

The Interview Schedule API allows you to create, update, view, delete, notify, and AI-evaluate interviews.
It includes role-based access control, interviewer-scoped filtering, AI transcript callbacks, and public access links for candidates.

Endpoints Overview

CategoryEndpointPurpose
FetchGET /api/interviewsGet all interviews (filters interviewer automatically)
Fetch OneGET /api/interviews/:idView full interview details
CreatePOST /api/interviewsCreate new interview schedule
NotifyPOST /api/interviews/:id/notifySend email + calendar invite
Public CandidateGET /api/interviews/public/candidate/:idPublic interview info

API Endpoints

Get All Interviews

GET /api/interviews
Returns all interviews.
If user role is “interviewer”, only their assigned interviews are returned.

Create Interview

POST /api/interviews
Creates a new interview with campaign, candidate, interviewer, timing, meeting link, and schedule name.

Get Interview by ID

GET /api/interviews/:id
Returns detailed information of a single interview.

Send Interview Notification (Email + Calendar Invite)

POST /api/interviews/:id/notify
Sends meeting mail with .ics file to candidate and interviewer.

Public Candidate Interview Information

GET /api/interviews/public/candidate/:id
Public read-only view for candidates scheduled for AI Interviews.