Jump to Content
Change Log
API Roadmap
Diagrams
Guides
API Endpoints
v1.0
Change Log
API Roadmap
Diagrams
Log In
API Endpoints
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Guides
API Endpoints
team-respondents
Search
JUMP TO
Getting started
Introduction
Staging vs production
Project Setup
Core Setup
Create a project
post
Create a screener question
post
Create multiple screener questions
put
Publish a project
patch
Extended Setup Actions
Retrieve audience size estimate
get
Upload NDA file
put
Copy a project
post
Create test participant (Staging only)
post
Project Management
Retrieve all projects
get
Retrieve a specific project
get
Update a project
patch
Pause a project
patch
Close a project
patch
Delete a project
delete
Screener Question Management
Retrieve screener questions
get
Retrieve specific screener question
get
Update screener question
patch
Delete screener question
delete
Reorder screener questions
patch
Screener Response Handling
View Responses & Profiles
List screener responses
get
View a specific response
get
Retrieve participant profile
get
Invite & Schedule Participants
Qualify participant
patch
Invite participant
patch
Schedule participant
patch
Cancel invite
patch
Cancel booking
patch
Cancel booking & re-invite
patch
Cancel booking (participant request)
patch
Update Participant Status
Mark as attended
patch
Mark as rejected
patch
Mark as no-show
patch
Report participant
patch
Mark as favorite
patch
Hide participant
patch
Payouts
Trigger manual payout
post
Retrieve payout counts
get
Messaging
Create Messages & Conversations
Create a conversation
post
Create a message
post
Add participant to conversation
post
View Messages & Conversations
Retrieve all messages
get
Retrieve unread conversations
get
Retrieve specific message
get
Retrieve all conversations
get
Retrieve specific conversation
get
Manage Conversations
Mark conversation as read
patch
Update a conversation
patch
Remove participant from conversation
delete
Lookup and Reference Data
Lookup Lists
Retrieve industry list
get
Retrieve job title list
get
Retrieve skill list
get
Retrieve topics list
get
Retrieve lookup values
get
Webhooks
Webhook Configuration
Create webhook
post
Retrieve webhook
get
Retrieve specific webhook
get
Retrieve webhook event types
get
Simulate webhook event
post
Deactivate webhook
delete
Team Tools
Team Features
Search past participants
get
Retrieve past participant profile
get
Invite multiple past participants
put
View credit and incentive balance
get
Powered by
team-respondents
