For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
    • Introduction
    • Users
    • Taskflow
    • AI Task Builder
    • Studies
    • Representative sample studies
    • study-collections
    • Filter Sets
    • Participant Groups
      • GETGet a list of all participant groups within a project or workspace
      • POSTCreate a new participant group within a workspace
      • GETGet a participant group
      • DELDelete a participant group
      • PATCHUpdate a participant group
      • GETGet a list of all participants within a participant group
      • POSTAdd participants to a participant group
      • DELRemove participants from a participant group
    • Custom Groups
    • Study Distribution
    • Submissions
    • Bonuses
    • Messages
    • Workspaces
    • Projects
    • Surveys
    • Webhooks
    • Invitations
    • Reward Recommendations
    • Testing
    • Well Known Endpoints
Go to app
LogoLogo
API Reference

Participant Groups

|View as Markdown|Open in Claude|

Participant groups are saved groups of participant IDs, so you can re-contact the exact same participants across studies. They are dynamic in nature, so you can add and remove participants from the group on the fly and any studies published with a participant group allowlist or participant group blocklist filter will be updated automatically. Participant groups allow you do the following:

  • Create a new participant group within the scope of a project.
  • Add and remove users manually to / from the participant group.
  • Use one or more participant groups as allowlist or blocklist filters for a new study.
  • Combined with study completion codes, automatically add or remove participants from a group when they submit a response to your study with the correct code.
  • Any participants added to or removed from the participant group on the fly will be automatically eligible or ineligible for studies that use a participant group allowlist or blocklist filter.
Was this page helpful?
Previous

Unlock filter set for editing

Next

Get a list of all participant groups within a project or workspace