Skip to main content

Overview & Use Cases

What is the Candidate API?​

The Candidate API is built to allow full customization of the screening process. It does not enforce a particular flow, but instead allows the web developer to implement their own self-assessment process.

See the API specification here.

Key Benefits​

For Study Sponsors​

  • Branded experience: The Candidate API provides the sponsor full control of the candidate facing material, including all UI elements.
  • Data control: The sponsor can choose to store candidates on different systems involved in the process.
  • Import data: Migration from other referral tracking systems can be in code.
  • Initial email: Allows to override the initial email communication originating from Trialbee.

For Candidates​

  • Embedded experience: No-third party material during the signup-process.

Core Features​

The Candidate API enables flexible integration for organizations requiring custom enrollment workflows:

  • Custom Sign-up Flows: Design enrollment processes that match your specific user experience requirements
  • System Integration: Import existing candidate data from CRM systems, databases, or other platforms. Note: You must convert your data into JSON before transmitting it.
  • Flexible Eligibility Logic: Handle qualification decisions within your application or delegate to Trialbee's screening engine
  • Form Builder Support: Compatible with popular form builders (like Gravity Forms) that can submit JSON to HTTPS endpoints

Maintenance​

The Candidate API is an actively maintained feature of Trialbee Honey, receiving regular updates for efficacy enhancement.