Search
User Documentation
QualRecruit Platform API Platform API Reference
QualRecruit Platform API
Authentication
Clients
POSTSearch clients
GETGet a client
Incentives
POSTSearch incentives
GETGet an incentive
Panel
GETList panel exports
POSTRequest a panel export
GETGet a panel export
GETGet the panel schema
GETGet a panelist
DELETEDelete a panelist
PUTUpdate a panelist
POSTSearch panelists
POSTCreate a panelist
POSTImport panelists in bulk
POSTUpdate panelists in bulk
Projects
POSTCreate a project
GETGet a project
GETList custom project properties
GETGet a project schema
GETList respondents in a project
GETGet a respondent
POSTMove respondents to another tab
POSTSearch projects
Schedule
GETList scheduled sessions for a project
System
POSTSearch the mail suppression list
POSTRemove addresses from the mail suppression list
POSTAdd addresses to the mail suppression list
Voice
GETList finished calls for a project

QualRecruit Platform API v1Proprietary

Tenant-facing API for retrieving information and manipulating projects, respondents, the panel, incentives and scheduling.

Server
https://{tenant_id}.service.respondentlink.app/-/api/v1

Production

Server Variables

Authentication

http ApiToken

Your API token

Clients

Operations related to clients

Incentives

Operations related to incentives

Schedule

Operations related to calendar invitations

Voice

Operations related to voice calls