Great Question

Apply a new interview screener template. Copy a template's questions onto an interview study's screener. All existing questions are removed and replaced.

apply_interview_screener_template

Apply a new survey screener template. Copy a template's questions onto a survey study's screener. All existing questions are removed and replaced.

apply_survey_screener_template

Apply a new unmoderated screener template. Copy a template's questions onto an unmoderated study's screener. All existing questions are removed and replaced.

apply_unmoderated_screener_template

Compose a new study message. Set the email template on this study for a kind. Idempotent: creates it from the account default on the first call and updates it thereafter. This is the copy the study sends. A study holds one template per kind, so composing the same kind again replaces what is already there, including copy someone wrote in the app - it is not how you draft several different one-off emails.

compose_study_message

Create a new candidate. Create a research participant (candidate). Idempotent on the account's unique id attribute (email / phone_number / external_identifier) — a matching existing candidate is updated instead of duplicated. Additional per-account custom attribute keys may be passed alongside the core fields.

create_candidate

Create a new interview screener. Replace the screener questions on an existing interview study. All existing questions are replaced by the provided set.

create_interview_screener

Create a new interview study. Create an interview study with optional screener questions in a single call.

create_interview_study

Create a new repo highlight. Highlight words in a session transcript. Choose one selection: a verbatim quote from get_repo_session_transcript, or both start_ms and end_ms. Prefer a quote: the transcript shows only MM:SS times, so use a time range only when you know the exact milliseconds. Use a quote when any selected words lack recording times, as in AI-moderated sessions; a time range selects only timed words. Copy numbers as the transcript spells them, usually in words ("fifteen", not "15"). A quote must match exactly one uninterrupted passage by one speaker; add words if it matches more than one. A time range selects all fully enclosed words, across speakers. A fully timed selection creates a clip usable in reels when source media exists or is uploading. Without source media, or when selected words lack timings, it creates a text-only highlight that cannot be used in reels. Requires a ready transcript and words not already marked by another highlight. Tags must be global or belong to the session's study.

create_repo_highlight

Create a new repo insight. Create an insight. To place a highlight or reel in the body, add a block `{"type":"references","attrs":{"items":[{"type":"highlight","id":"<uuid>"}]}}`. highlight_uuids and reel_tokens embed after the body.

create_repo_insight

Create a new repo reel. Compile highlights into a new reel, in the given order. Take highlight uuids from list_repo_highlights, search_repo_highlights or create_repo_highlight. Each highlight must have a clip: a highlight made on untimed transcript words cannot go in a reel. Each highlight may appear once. The reel's video is stitched in the background, usually within a few minutes; `video_status` reads building until it is ready, so check again with get_repo_reel.

create_repo_reel

Create a new repo tag. Apply it to a highlight, reel or insight with apply_repo_tag. Give study_id to scope it to that study; omit it for a global tag. A group must belong to the same study, or be global for a global tag. Names are unique within a study, ignoring case. Check search_repo_tags with q first and reuse an existing tag instead of recreating it. If the name is taken, the error names the existing tag and its id; apply that tag with apply_repo_tag instead.

create_repo_tag

Create a new survey screener. Replace the screener questions on an existing survey study. All existing questions are replaced by the provided set.

create_survey_screener

Create a new survey study. Create a survey, optionally with its questions in a single call. Screener (qualification) questions are added separately via create_survey_study_screener.

create_survey_study

Create a new unmoderated block. Add a task or question block to an unmoderated study, in a single call. The block's type is set by `kind`; each kind accepts its own fields (see below). Structural blocks (welcome, thank you, permissions, AI-moderated interview) are created with the study and cannot be added here. Prototype-test blocks fetch their screen graph from the design tool asynchronously, so screens and paths are not present in the immediate response.

create_unmoderated_block

Create a new unmoderated screener. Replace the screener questions on an existing unmoderated study. All existing questions are replaced by the provided set.

create_unmoderated_screener

Create a new unmoderated study. Create an unmoderated study with optional screener questions in a single call.

create_unmoderated_study

Delete a candidate. Permanently forget a candidate: destroys screener responses, detaches clips, and wipes PII (via Customer#forget!). This action is irreversible.

delete_candidate

Delete an interview screener. Remove all questions from an interview study's screener.

delete_interview_screener

Delete an interview screener question. Remove a single question from an interview's screener.

delete_interview_screener_question

Delete an interview study. Soft-delete (discard) an interview.

delete_interview_study

Delete a repo highlight. Its words are unmarked in the transcript, its clip is removed from every reel that uses it, and insights that embed it stop showing it.

delete_repo_highlight

Delete a repo insight. Its embedded highlights and reels stay.

delete_repo_insight

Delete a repo reel. Its highlights stay.

delete_repo_reel

Delete a survey question. Remove one question from a survey body and clear branches that target it.

delete_survey_question

Delete a survey screener. Remove all questions from a survey study's screener.

delete_survey_screener

Delete a survey screener question. Remove a single question from a survey's screener.

delete_survey_screener_question

Delete a survey study. Soft-delete (discard) a survey.

delete_survey_study

Delete an unmoderated block. Remove a block from an unmoderated study. Structural blocks (welcome, thank you, permissions, AI-moderated interview) are pinned and cannot be removed.

delete_unmoderated_block

Delete an unmoderated screener. Remove all questions from an unmoderated study's screener.

delete_unmoderated_screener

Delete an unmoderated screener question. Remove a single question from an unmoderated study's screener.

delete_unmoderated_screener_question

Delete an unmoderated study. Soft-delete (discard) an unmoderated study.

delete_unmoderated_study

Discard a study message. Discard a one-off message written for a single send. A study's own email template cannot be discarded.

discard_study_message

Get a single candidate by ID. Research participants (people who take part in studies). Returns full profile including name, email, and demographics. For a candidate's status in a study, use list_study_participants.

get_candidate

Get a single candidate segment by ID. A saved candidate-filter definition ("segment") within the account. Returns id and name.

get_candidate_segment

Get a single interview calendar settings by ID. Fetch calendar booking settings for an interview.

get_interview_calendar_settings

Get a single interview response by ID. Fetch a single interview screener response by id with structured answers and qualification data.

get_interview_response

Get a single interview screener by ID. Fetch the screener questions for an interview study.

get_interview_screener

Get a single interview screener response by ID. Fetch a single interview screener response by id with structured answers and qualification data.

get_interview_screener_response

Get a single interview study by ID. Fetch a single interview by id with full details.

get_interview_study

Get a single message template by ID. Fetch the account's default template for a given kind (one of: invite, screener, booked, thanks, welcome, reschedule_request, cancel_interview, cancel_task, booked_reminder, started_reminder, invited_reminder, ad_hoc, signed_consent_form). Falls back to the system default when no account template exists.

get_message_template