Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. Booking Links
  • 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
      GET
  • The Direct Training Academy
    • Bookings
      • Get Past Bookings
      • Get Upcoming Bookings
      • Search Bookings by Date
    • Booking Links
      • Search Booking Links
        GET
  • Schemas
    • Booking
    • TokenResponse
    • InterviewBooking
    • Pagination
    • BookingInvite
    • ReferenceRequest
    • BookingsResponse
    • Reference
    • BookingLinksResponse
    • ReferenceDetail
    • CreateReferenceRequest
    • RefereeInput
    • Template
    • WebhookEndpoint
    • CreateWebhookEndpoint
    • UpdateWebhookEndpoint
    • WebhookCall
    • WebhookPayload
    • PaginationMeta
    • PaginationLinks
    • Error
    • RateLimitError
    • ValidationError
  1. Booking Links

Search Booking Links

GET
/booking-links/search
Maintainer:Not configured
Search for booking invitation links with optional filters

Request

Authorization
API Key
Add parameter in header
API-Key
Example:
API-Key: ********************
or
Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/booking-links/search?creation_date&usage_date&is_used&per_page' \
--header 'API-Key: <api-key>'

Responses

🟢200
application/json
Successful response
Body

Example
{
    "data": [
        {
            "name": "string",
            "email": "user@example.com",
            "is_sent": true,
            "is_used": true,
            "cgo_name": "string",
            "cgo_email": "user@example.com",
            "booking_link": "http://example.com",
            "booking": {
                "tdta_first_name": "string",
                "tdta_last_name": "string",
                "tdta_email": "user@example.com",
                "tdta_phone": "string",
                "tdta_job_role": "string",
                "tdta_training_paid_by": "string",
                "tdta_agency": "string",
                "booking_status": "string",
                "booked_by": "string",
                "agency_contact_name": "string",
                "agency_contact_email": "user@example.com",
                "course": "string",
                "location": "string",
                "trainer": "string",
                "start_date": "2019-08-24T14:15:22.123Z",
                "end_date": "2019-08-24T14:15:22.123Z",
                "attendance": "passed",
                "attendance_updated_date": "2019-08-24T14:15:22.123Z",
                "uuid": "string",
                "candidate_id": 0,
                "certificate_link": "string",
                "booking_date": "2019-08-24T14:15:22.123Z",
                "updated_date": "2019-08-24T14:15:22.123Z"
            },
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "pagination": {
        "total": 0,
        "per_page": 0,
        "current_page": 0,
        "last_page": 0,
        "next_page_url": "string",
        "prev_page_url": "string"
    }
}
🟠422
🟠401UnauthorizedError
Modified at 2026-02-10 16:01:30
Previous
Search Bookings by Date
Next
Booking
Built with