Notice

The Recruitment API will be deprecated in a future release of ClinSpark. Our intention is to have a single API capable of delivering on all use cases for recruitment workflows, focusing on more flexible and dynamic capabilities that the ‘Recruit’ API can offer.

Recruit API

Customers using the Recruitment API are encouraged to explore use of the Recruit API, which can support more advanced workflows and website integration needs.

We intend to provide advanced warning and further information to our customers when a decision is made to fully end support for Recruitment API, so transition plans can be established.

Introduction

The Recruitment API was introduced in early versions of ClinSpark and offers a basic set of capabilities to integrate with a recruitment website. This document refers to the use of that basic Recruitment API.

While it still exists in current releases, it will be deprecated eventually (see notice above).

This Recruitment API is documented (and is testable using Swagger), below. For information about how to use the embedded Swagger UI and prerequisites for use, refer to this article:

ClinSpark APIs | Prerequisites for use

Interactive API documentation

The current version of the Swagger UI is setup to demonstrate use with ClinSpark accounts that use Basic HTTP authentication.