API Reference: Interviews

Interviews

Resource

The interview resource represents a full life-cycle of any given interview, for the initial interview request to after the interview is complete. Each interview has a unique primaryUser, secondaryUser and startTime.

interface Interview {
   id: uuid;
   status: InterviewStatus;
   primaryUserId: uuid; // Represents inviter
   secondaryUserId: uuid; // Represents invitee
   startTime: string; // ISO DateTime string in UTC (on the hour)
   languages: CodingLanguage[] // Represents matched coding languages between the users
   questions: InterviewQuestion[];
   questionDifficulties: QuestionDifficulty[];
   questionTypes: QuestionType[];
   code: string;
}
// TODO: Other requirements for WebRTC, etc.

InterviewStatus

enum InterviewStatus {
   INVITED, CONFIRMED, COMPLETED, CANCELLED
}

Get Interviews - GET /interviews

Authenticated request with optional query param for status

GetInterviewResponse

interface GetInterviewResponse {
   interviews: [{
      user {

      },
      startTime: string; 
   }]
}

Create Interview - POST /interviews

CreateInterviewRequest

interface CreateInterviewRequest {
   availabilityId: uuid;
   secondaryUserId: uuid;
   startTime: string;
}