client.recruitment

See Recruitment and embedding for attribution and embedding.

get()

client.recruitment.get(study_id) -> RecruitmentOut

Participation links (text, plus voice and video when enabled, each with a short variant), quota status and whether screening and characteristics are switched on. Append &source=<tag> and/or &participant_id=<your id> to a link to attribute arrivals. They’re recorded on the interview as web_source and external_participant_id. Returns RecruitmentOut.

update()

client.recruitment.update(
    study_id,
    *,
    short_url_slug: str | None = None,
    max_responses: int | None = None,
    clear_max_responses: bool | None = None,
    redirect_url: str | None = None,
) -> RecruitmentOut

Set the short-link slug, response quota or post-completion redirect. Fields you omit are left as they are.

str

Custom short-link slug: lowercase letters, digits and hyphens, unique across all studies.

int

Response quota.

bool

Set to True to remove the quota.

str

Where participants go after completing. May contain {{external_participant_id}}.

Returns RecruitmentOut.

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

get()

update()

​get()

​update()

get()

update()