Introduction
The Recruit API was introduced in ClinSpark 1.5.5, and significantly expands the capabilities of the previously implemented Recruitment API. Capabilities of the API are also accompanied by the use of the ‘RecruitmentApiHandler’ system setting in ClinSpark, available to IQVIA ‘superadmin’ users.
Currently, both APIs exist for use with recruitment website integrations. ClinSpark customers who are already integrated using the Recruitment API should continue to use it as currently implemented/documented within it’s section of the help site.
If there are questions about use of the API for recruitment website integration, please reach out to the IQVIA team via the service desk. Specific support for the design and configuration of your website is not provided, but we are able to support our APIs.
Important information on setting up the integration to your website can be found here Recruitment Website Integration
Functionality
Your participant recruitment website developer will be able to use this API for the following:
allow the import of new volunteers
allow existing volunteers to express interest in a specific study / cohort
allow volunteers to update their own details
match volunteers to suitable studies based on details they submit
allows volunteers to select an open appointment for a study they are qualified for
allows volunteers to cancel their own appointment
Interactive Documentation with Swagger
This API is documented (and is testable using Swagger), below.