Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. Reference Requests
  • 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
        GET
      • Create reference request
        POST
      • Get reference request
        GET
      • Cancel reference request
        POST
      • Add referee to request
        POST
      • Send reminders
        POST
    • 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
  • 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. Reference Requests

Add referee to request

POST
/reference-requests/{uuid}/referees
Maintainer:Not configured
Add a single referee to an existing reference request. The referee will immediately receive an email with a link to the reference form.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Body Params application/jsonRequired

Example
{
    "referee_name": "Jane Smith",
    "referee_email": "jane@company.com",
    "referee_organisation": "ABC Corp",
    "referee_position": "Line Manager",
    "referee_phone": "+44 7700 900000",
    "relationship_to_candidate": "Direct supervisor"
}

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 POST '/reference-requests//referees' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referee_name": "Jane Smith",
    "referee_email": "jane@company.com",
    "referee_organisation": "ABC Corp",
    "referee_position": "Line Manager",
    "referee_phone": "+44 7700 900000",
    "relationship_to_candidate": "Direct supervisor"
}'

Responses

🟢201
application/json
Referee added
Body

Example
{
    "data": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "reference_request_id": 0,
        "referee_name": "Jane Smith",
        "referee_email": "user@example.com",
        "referee_organisation": "ABC Corp",
        "referee_position": "Line Manager",
        "referee_phone": "string",
        "relationship_to_candidate": "string",
        "status": "pending",
        "status_label": "Completed",
        "score": 4.2,
        "decline_reason": "string",
        "form_url": "string",
        "pdf_url": "string",
        "sent_at": "2019-08-24T14:15:22.123Z",
        "opened_at": "2019-08-24T14:15:22.123Z",
        "submitted_at": "2019-08-24T14:15:22.123Z",
        "expires_at": "2019-08-24T14:15:22.123Z",
        "reminder_count": 0,
        "last_reminder_sent_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    },
    "message": "string"
}
🟠422
Modified at 2026-02-17 18:56:15
Previous
Cancel reference request
Next
Send reminders
Built with