Skip to main content
GET
List interview definitions

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

type
enum<string>
default:interview

Which kind to list. Options — interview (default): interviews, assessments, interview role-plays (persona-create with portal interview) and multi-stage positions. | coaching: coaching sessions and coaching personas. | assessment: assessments only. | persona: coaching personas only. | persona_interview: interview role-plays only. | public_avatar: public avatars.

Available options:
interview,
coaching,
assessment,
public_avatar,
persona,
persona_interview
Example:

"interview"

status
enum<string>

Filter by publication status (preparing: a draft still being prepared; completed: finished, read as closed). Omit to include all statuses.

Available options:
draft,
active,
archived,
deleted,
preparing,
completed
Example:

"active"

show_public
enum<string>
default:false

Include interviews shared publicly across merchants (coaching/avatars).

Available options:
true,
false
Example:

"false"

show_demo
enum<string>
default:false

Include demo/sample interviews.

Available options:
true,
false
Example:

"false"

filter_text
string

Case-insensitive search on the interview name.

filter_emoji
string

Filter by the interview emoji marker.

lifecycle
enum<string>

Only multi-stage positions in this vacancy lifecycle (as lifecycle_status shows it). Interviews have no lifecycle, so this lists positions only.

Available options:
draft,
pending_approval,
open,
applications_closed,
on_hold,
filled,
cancelled,
closed
Example:

"open"

recruiter_profile_id
string<uuid>

Only definitions owned by this recruiter (profile.id).

interview_category
string

Only definitions in this job category (case and surrounding spaces ignored).

limit
integer
default:50

Maximum number of records to return (1–1000).

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

50

offset
integer | null
default:0

Number of records to skip from the start of the result set.

Required range: x >= 0
Example:

0

Response

A page of interview definitions with pagination metadata.

data
object[]
required

The merchant's interview definitions for this page, newest-updated first.

pagination
object
required