Skip to main content
GET
Get organization interview defaults

Authorizations

Authorization
string
header
required

API key authentication for the public API. Pass your API key as a Bearer token.

Response

id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
prompt_intro
string

Default intro script for new interviews in this organization.

prompt_outro
string

Default outro script for new interviews in this organization.

prompt_additional_instructions
string

Default additional voice-assistant instructions for new interviews in this organization.

interviewer_name_override
string

Org-wide interviewer name for interviews. Blank falls back to the system default name.

Maximum string length: 100
organization_name_override
string

Org-wide organization name spoken in interviews. Blank falls back to the organization's name.

Maximum string length: 100
cv_context_mode
enum<string>

How much of the candidate's CV the interview agent receives. SUMMARY gives the latest role and top skills only. DISABLED omits the CV entirely. FULL gives the complete dated work and education history AND lets the agent raise up to two topics drawn from it, so it may ask about a career change or an unexplained employment gap. Choose FULL only if that questioning is wanted, not merely to give the agent more context.

  • disabled - Disabled (No CV context)
  • summary - Summary (Key highlights only)
  • full - Full (Complete CV markdown)
Available options:
disabled,
summary,
full

When enabled, the interviewer asks the candidate to agree to the call being recorded before the interview starts, and ends the call if they decline. When disabled, no consent question is asked.

default_interview_mode
enum<string>

Interview mode applied to new job postings that do not specify one. WEB runs the interview in the browser, PHONE calls the candidate.

  • web - Web
  • phone - Phone
Available options:
web,
phone
generation_additional_instructions
string

Extra instructions passed to criteria and question generation for every job in this organization, for example to ask for a short screening rather than a full interview. Blank means no extra steering.