Introduction

The Recruitment API was originally introduced in early versions of ClinSpark and offers a basic set of capabilities to integrate ClinSpark with a recruitment website. It still exists today, and can be used in current (latest) ClinSpark releases. This document refers to the use of that basic Recruitment API.

However, current ClinSpark releases offer an updated API called Recruit. This newer API has an accompanying system setting, which can support more advanced workflows and website integration needs. That Recruit API is documented in it’s own separate section of the help site.

If there are questions about use of the API for recruitment website integration, please reach out to the Foundry Health team via the service desk.

This API is documented (and is testable using Swagger), below.

Prerequisites to use the API documentation

1. Users will need to have an account on the ClinSpark instance used (‘server’)

2. The user must be allowed to use HTTP Basic Authentication

   1. 

3. For non-superdministrator users, they must have the api Role Action in one of their assigned Roles

Interactive API documentation