Skip to main content

Overview & Use Cases

What is the Patient Registry API?​

The Patient Registry API is a REST API that enables external parties to programmatically create lead records in Trialbee Honey. It provides a secure endpoint for submitting basic lead information including email, consent details, demographic data, and geographic information.

Key Features​

  • Authentication via APIKey or OAuth 2.0: Secure access via Client Credentials flow using client ID and secret or via APIKey provided by Trialbee
  • Rate Limiting: Built-in mechanisms to manage traffic and protect system stability under high usage
  • Optional Enrichment: Supports additional demographic and geographic data (country code, locale, postal code)

Use Cases​

The Patient Registry API is ideal for:

  • Landing Pages & Marketing Campaigns: Capture lead information from custom web forms without using the Trialbee widget
  • CRM Integrations: Sync leads from external CRM systems or marketing automation platforms
  • Multi-Channel Lead Collection: Aggregate leads from multiple sources into Trialbee Honey
  • Custom Applications: Build tailored lead capture experiences that integrate seamlessly with your existing infrastructure

How It Works​

  1. Authenticate using an ApiKey or OAuth 2.0 Client Credentials flow to obtain an access token.
  2. Submit Patient Registry Data via POST to /rest/v1/leads endpoint with email, consent, and demographic information
  3. Receive Confirmation response with the newly created lead ID and associated person details upon successful creation.

See the API specification here.

Maintenance​

The Patient Registry API is an actively maintained feature of Trialbee Honey, receiving regular updates and continuous improvements.