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
/v1/profiles/{profileId}
Search
JUMP TO
Getting started
Introduction
Staging vs production
Project Setup
Core Setup
/v1/projects
post
/v1/projects/{projectId}/screener-questions
post
/v1/projects/{projectId}/screener-questions/bulk
put
/v1/projects/{projectId}/publish
patch
Extended Setup Actions
/v1/projects/{projectId}/feasibility/audience-size-estimate
get
/v1/projects/{projectId}/files/form-data
put
/v1/projects/{projectId}/copy
post
/v1/profiles
post
Project Management
/v1/projects
get
/v1/projects/{projectId}
get
/v1/projects/{projectId}
patch
/v1/projects/{projectId}/pause
patch
/v1/projects/{projectId}/close
patch
/v1/projects/{projectId}
delete
Screener Question Management
/v1/projects/{projectId}/screener-questions
get
/v1/projects/{projectId}/screener-questions/{screenerQuestionId}
get
/v1/projects/{projectId}/screener-questions/{screenerQuestionId}
patch
/v1/projects/{projectId}/screener-questions/{screenerQuestionId}
delete
/v1/projects/{projectId}/screener-questions/order
patch
Screener Response Handling
View Responses & Profiles
/v1/projects/{projectId}/screener-responses
get
/v1/projects/{projectId}/screener-responses/{screenerResponseId}
get
/v1/profiles/{profileId}
get
Invite & Schedule Participants
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/qualify
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/invite
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/schedule
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/cancel-invite
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/cancel-booking
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/cancel-booking-reinvite
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/participant-cancel-booking
patch
Update Participant Status
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/attended
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/reject
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/no-show
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/report
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/favorite
patch
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/hide
patch
Payouts
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/payouts
post
/v1/projects/{projectId}/screener-responses/payouts
get
Messaging
Create Messages & Conversations
/v1/messaging/conversations
post
/v1/messaging/conversations/{conversationUid}/messages
post
/v1/messaging/conversations/{conversationUid}/participants
post
View Messages
/v1/messaging/messages
get
/v1/messaging/messages/inbox
get
/v1/messaging/messages/{messageUid}
get
/v1/messaging/conversations
get
/v1/messaging/conversations/{conversationUid}
get
Manage Conversations
/v1/messaging/conversations/{conversationUid}/read
patch
/v1/messaging/conversations/{conversationUid}
patch
/v1/messaging/conversations/{conversationUid}/participants/{participantUserId}
delete
Lookup and Reference Data
Lookup Lists
/v1/industries
get
/v1/job-titles
get
/v1/skills
get
/v1/topics
get
/v1/lookups
get
Webhooks
Webhook Configuration
/v1/webhooks
post
/v1/webhooks
get
/v1/webhooks/{webhookId}
get
/v1/webhooks/{webhookId}/event-types
get
/v1/webhooks/{webhookId}/simulate
post
/v1/webhooks/{webhookId}
delete
Team Tools
Team Features
/v1/team-respondents
get
/v1/team-respondents/profiles/{profileId}
get
/v1/team-respondents/batch-invite
put
/v1/pricing/balances/summary
get
Powered by
/v1/profiles/{profileId}
get
https://api-staging.respondent.io/v1/profiles/
{profileId}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
