Healthier Business Group
Home
HB Portal
Request API access
Home
HB Portal
Request API access
Contact Us
Copy Page
Walk through Healthier Business Group 🔵
Heathier Business Portal APIs V2
Authentication
Get access token
Refresh access token
Get token info
Revoke current token
Reference Requests
References
Get reference detail
Download reference PDF
List reference requests
Create reference request
Get reference request
Cancel reference request
Add referee to request
Send reminders
Candidate Requests
Training Requests
OH Requests
Practical Training Requests
BLS Requests
Appraisal Requests
Certificate Requests
Training Verification Requests
Webhooks
List webhook endpoints
Create webhook endpoint
Update webhook endpoint
Delete webhook endpoint
View webhook call logs
Send test webhook
Templates
List form templates
Heathier Business Portal APIs V1 - Deprecated
Candidate Requests
Get All Candidates
Get Candidate Data
Create New Candidate
Update Candidate Details
Training Requests
Get Available Trainings
Get Candidate Course Result
Get Candidate Training Report
Get Candidate Training Report - Unassigned
OH Requests
Get Available Forms
Get Form Fields
Creating a new submission
Modifying the details of an existing submission (Upload Documents)
Make final form submission (after uploading documents)
Get submission list
Retrieve submission result details
Retrieve the submission result documents for the employer
Certificates Requests
Get Training Certificate
Get Training Certificate - including expired
Get Training Certificate - including non-assigned courses, but excluding expired
Get Training Certificate - All available courses
Get Training Certificate - Specific Course
Webhooks
Training Completion
Course Completion
HB Services
List Interview Bookings
The Direct Training Academy
Bookings
Get Past Bookings
Get Upcoming Bookings
Search Bookings by Date
Booking Links
Search Booking Links
Schemas
Booking
TokenResponse
InterviewBooking
Pagination
BookingInvite
ReferenceRequest
BookingsResponse
Reference
BookingLinksResponse
ReferenceDetail
CreateReferenceRequest
RefereeInput
Template
WebhookEndpoint
CreateWebhookEndpoint
UpdateWebhookEndpoint
WebhookCall
WebhookPayload
PaginationMeta
PaginationLinks
Error
RateLimitError
ValidationError
Error
Copy Page
{
"error"
:
"string"
,
"message"
:
"string"
}