Skip to main content
GET
List interviews
Lists interviews with pagination and filtering options. For MVP, the candidateId query parameter is required to filter interviews.

Overview

The list interviews endpoint allows you to retrieve interviews for a specific candidate. This is useful for tracking a candidate’s interview history, checking interview status, and retrieving analysis results.

Required Filter

MVP Requirement: The candidateId query parameter is currently required. You must specify a candidate ID to list interviews. Listing all interviews without a filter is not yet supported.

Use Cases

  • Candidate Interview History: View all interviews for a specific candidate
  • Status Tracking: Monitor interview progress and completion
  • Analysis Retrieval: Access interview analysis and transcripts
  • Pipeline Management: Track interviews across your recruitment process

Basic Usage

With Pagination

Status Filtering

You can filter interviews by status (when supported):

Response Structure

The response includes interview details along with analysis data (when available):

Tracking Interview Progress

Company Isolation

All returned interviews belong to candidates that are associated with jobs in your API key’s company. You cannot access interviews from other companies.

Interviews Resource Guide

Learn about interview management and analysis

Get Interview

Retrieve a specific interview by ID

Pagination Guide

Understand pagination best practices

Candidates Resource Guide

Manage candidate profiles

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Query Parameters

page
integer
default:1

Page number (1-based)

Required range: 1 <= x <= 10000
Example:

1

limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

companyId
string<uuid>

Company ID (required for ATS keys, optional for regular keys)

Example:

"123e4567-e89b-12d3-a456-426614174000"

candidateId
string<uuid>
required

Filter by candidate ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

agentId
string<uuid>

Filter by agent ID

Example:

"987e6543-e21b-12d3-a456-426614174000"

status
enum<string>

Filter by interview status

Available options:
UNDEFINED,
SCHEDULED,
CANCELLED,
FAILED,
COMPLETED,
IN_PROGRESS
Example:

"SCHEDULED"

jobId
string

[Deprecated] Filter by job ID (through candidate). Redundant when candidateId is required.

Example:

"456e7890-e12b-34d5-a678-901234567890"

Response

200 - application/json
data
object[]
required

Array of interviews

total
number
required

Total number of items

Example:

150

page
number
required

Current page number

Example:

1

limit
number
required

Number of items per page

Example:

20

totalPages
number
required

Total number of pages

Example:

8