Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
Getting Started
The QualRecruit API is a preview feature and is subject to change.
The QualRecruit Public API is an enterprise feature that must be enabled on your tenant. Please contact your account representative for information.
Introduction
QualRecruit has a limited public API that can be accessed to obtain information and perform basic manipulation of the following types of data associated with your tenant:
Clients
Incentives
Panelists
ProjectsLimiting
Respondents
Schedules (Calendar Invitations)
Voice Calls
Authorization
All calls to the API endpoint must include an Authorization header that contains an API key as a bearer token. If you have sufficient user permission on the platform, you can create and delete API keys in the Admin section of the platform.
API keys do not have an access level (all API keys have full permissions) and never expire. If you would like to rotate your API key, you may generate an additional key to roll out and test before deleting the old key. Deleting an API key immediately invalidates it and all future calls using the deleted key will fail.
API keys are sensitive credentials. An API key will grant read/write access to data on your tenant. You must store all API keys on trusted and encrypted systems that meet rigorous industry safety standards regarding the secure storage of keys and secrets.
Endpoint
The root path of the API endpoint is:
Where tenant_id is the identifier of your tenant. The full URL can be accessed by selecting the "Endpoint" button on the API panel of the Admin section of the platform.
Please see the individual API documentation for the full path to each call.
Rate Limiting
Access to the API is rate limited. If you receive HTTP 429 errors, you should wait a few seconds to resume your requests. We recommend implementating progressive backoffs and retries if you continue to encounter rate limiting errors.