Skip to main content
API docs by Redocly

Trialbee Candidate API (1.0)

Download OpenAPI specification:Download

E-mail: [email protected] License: UNLICENSED

Candidate API by Trialbee.

This public API can be used to roll your own custom self-assessment solution using standard HTML-forms, Wordpress forms or any other custom integration.

Introduction

This API is documented in OpenAPI format. In addition to standard OpenAPI syntax we use a few vendor extensions.

Rate limitation

This API uses a rate limitation. The default limit is 100 submissions per hour. Discuss with your assigned Trialbee Project Manager if you need to increase the limit temporarily.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

Candidate API requires authentication in order to accept submissions. We currently support an API-key based approach.

ApiKeyAuth

Security Scheme Type: API Key
Query parameter name: credential

candidates

Public API operations available to all studies that have enabled the API-functionality.

Create a new candidate record in Trialbee Honey

path Parameters
credentials
required
string <password>
Example: B886CCEA-4592-11EE-B632-ACDE48001122

API Token provided by Trialbee. Note that the token might be locked to certain origins.

Request Body schema: application/json

Submit a single Candidate

object (Candidate)
object (CandidatePreferences)
object (CandidateConsent)
object (SelfAssessment)

Answers to self assessment questions is used both for qualifying a candidate into a study and for reporting regarding how individual questions are answered. This block of the API supports different operating modes.

object (Attribution)
object (ClientInformation)

Responses

Request samples

Content type
application/json
{
  • "candidate": {
    },
  • "preferences": {
    },
  • "consent": {
    },
  • "selfAssessment": {
    },
  • "attribution": {
    },
  • "clientInformation": {}
}

Response samples

Content type
application/json
{
  • "submissionId": "1-654502ef-01c39e98406a093a0ca5c585"
}