Available tool calls
The MCP exposes the following tools, organized by research workflow stage. Write tools can create, update, and delete resources. Read tools retrieve and search data.Candidate tools
You can also browse and search your account’s saved candidate segments (
list_candidate_segments, get_candidate_segment, search_candidate_segments) and pass a segment ID into search_candidates to pull everyone matching that segment.
Study tools (all types)
These tools work across all study types (interviews, surveys, and unmoderated studies).Configuring study setup
When creating or updating any study type, you can configure:- Incentives:
- incentive_method (manual, tremendous, coupon, product, other)
- incentive (amount in whole currency units)
- currency (USD, AUD, TRY, GBP, CAD, EUR, or JPY)
- incentive_title
- incentive_instructions
- incentive_coupons (codes, when the method is coupon)
- Participation caps: participation_limit to cap how many people can participate
- interview studies accept an object with count and cadence (total or weekly);
- surveys and unmoderated studies accept an integer (total only).
- As-started grace period: maximum_as_started_in_minutes — how long a participation can sit in “Started” before it reverts to “Invited” (defaults to 60 minutes for surveys and unmoderated studies; interview studies don’t use this).
- Consent form: consent_form_id to attach a consent form (discover IDs with list_consent_forms / search_consent_forms).
- Participant language: language for emails, booking pages, and public participation surfaces (de, en, es, fr, it, pt-BR, tr; defaults to en).
- Scheduling style: scheduling_style (one_on_one, round_robin, or collective)
- with round_robin_assignment (availability or fairness) when using round robin.
- Meeting provider: meeting provider (manual, zoom, google_meet, microsoft_teams, webex, in_person) and duration_in_minutes.
- Calendar & availability: availability (weekly hours, timezone, and booking window) and buffer_minutes. Booking limits and scheduling notice are configured separately — see Scheduling tools below.
Interview study tools
Study management:Screeners
Survey study tools
Study management:Screeners
Unmoderated study tools
Unmoderated studies cover self-guided research, prototype tests, website tests, card sorts, and tree tests. Each study is built from an ordered set of blocks (the tasks and questions a participant works through). Study management:Blocks
Block kinds. Set
kind on create_unmoderated_block and pass the fields for that kind. Every kind also accepts the shared title, description, and required. The id returned on create is what you pass back to update_unmoderated_block and reorder_unmoderated_block.
number_range_options shape (linear scale). Same vocabulary as the number_range screener question, so a scale is authored the same way in a screener or a block:
min and max are integers and define the endpoints. labels is optional and keys are the position as a string; unlabelled positions render as the number alone. Updating a labelled scale (say 1–5 → 1–7) keeps the labels of the surviving positions and lets you add labels for the new ones; narrowing drops labels that fall outside the new range.
Screeners
Scheduling tools
Interview calendar:Interview moderators
Study message tools
Customize the emails a study sends, invitations, screener invites, reminders, booking confirmations, thank-yous, and more, before you send them. Templates are your account’s per-kind defaults. A study holds one email template per kind, seeded from those defaults the first time that kind is opened or sent, and that is the copy the study actually sends. A study can also hold one-off copies written in the app for a single send; those carrycustom: true and no automatic send reads them.
Participant tools
Tools for reading and changing a study’s participants, and for adding candidates to a study. Read and change participant status. A participant’s status is the source of truth for attendance. A session with a recording does not mean the participant showed up, because recording starts when the moderator joins.
Shortlisting adds existing candidates to the study’s participant list; sending a screener invitation emails them to fill out the study’s screener. You can combine them (shortlist candidates first, then optionally send them a screener to qualify) or use either on its own.
Shortlist existing candidates. Each call automatically skips candidates who are already on the study, inaccessible to your team, uncontactable, or ineligible.
Send a screener invitation. Email candidates a link to fill out the study’s screener. Works whether or not they’ve already been shortlisted.
Session & Transcript tools
Response tools
Access participant responses across all three study types. What a “response” contains depends on the study type:- Interview studies: screener responses, the candidate’s answers to the screener questions, with qualification status and match score. The interview session itself is accessed via the Session & Transcript tools.
- Survey studies: the full survey submission, the participant’s answers to the survey questions.
- Unmoderated studies: the full submission, answers, task metrics, timings, and recording link from the recorded session, with a pointer to the session transcript included on the response.
Screener responses are also available per study type via the dedicated screener-response tools (e.g.
get_interview_screener_response, list_survey_screener_responses, search_unmoderated_screener_responses). For interview studies, these return the same underlying data as get_interview_response and friends — interviews only have one screener, so there’s no separate qualification-screener dataset to distinguish. For surveys and unmoderated studies, the screener-response tools return a distinct qualification screener, separate from the study’s main response data.
get_screener_response is a generic lookup that works across all three study types: pass a screener response ID and it returns that response, scoped to qualification screeners only.
Artifact tools (Highlights, Insights & Reels)
get_repo_highlight and get_repo_reel do not return playable video or thumbnail URLs, at the reel level or per clip. To reach recording content, use get_repo_session and get_repo_session_transcript on the referenced session. Candidate names on these responses are masked for consumers without team access to the candidate or without PII permission, matching the masking applied elsewhere in the API.Template tools
Reuse your account’s saved screener templates instead of rebuilding questions from scratch every time.Workspace tools
A few helpers surface the building blocks you reference when setting up studies:- Teams (
list_teams,get_team,search_teams) — your account’s teams; pass a team ID when creating or assigning a study. - Consent forms (
list_consent_forms,search_consent_forms) — consent forms available to attach to a study via consent_form_id. - Candidate segments (
list_candidate_segments,get_candidate_segment,search_candidate_segments) — saved candidate filters; use a segment ID with search_candidates.
Common tool call parameters
Most list and search tools support these options:- Pagination:
page(default 1),items(default 20, max 100) - Date filtering: a single timestamp per filter (e.g.
submitted_at,updated_since) that returns records after that point in time — there’s no end-bound window or relative-duration syntax
Security & data handling
For full privacy details, see our Privacy Policy.