Introduction

The Recruit API enables customers to integrate their recruitment websites with ClinSpark. It also contains the flexibility to support other recruitment-based workflows.

Certain capabilities of the API are maintained through the ‘RecruitmentApiHandler’ system setting in ClinSpark. This system setting is managed by IQVIA superadmin users but can be modified as needed to meet customer-specific needs, depending on the use case.

If there are questions about use of the Recruit API for external integrations with ClinSpark, 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.

Recruit API

Introduction

Functionality

Interactive Documentation with Swagger

See Also