Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. Candidate 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
      • 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
      • Get Candidate Data
        GET
      • Create New Candidate
        POST
      • Update Candidate Details
        PATCH
    • 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. Candidate Requests

Get Candidate Data

GET
/candidates/{{candidate_ref}}
Maintainer:Not configured
This endpoint retrieves candidate data. The URI format is: https://hb-host.tld/api/candidates/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
The request is HTTP GET (RFC2616) and use candidate_ref as resource identifier,
which is a UUID string, identifying the candidate uniquely at HB.

Request

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

Body Params application/x-www-form-urlencoded

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 -g --request GET '/candidates/{{candidate_ref}}' \
--header 'Accept: application/json' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>'

Responses

🟢200Get Candidate Data
application/json
Body

Example
[
    {
        "candidate": {
            "candidate_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "candidate_id": "0000000",
            "user_id": "0000000",
            "training_id": "0000000",
            "client_id": "000",
            "first_name": "first_name",
            "last_name": "last_name",
            "email": "email@domain.co.uk",
            "username": "username",
            "client_record_ref": "",
            "candidate_status": "activated",
            "archived": "0",
            "candidate_group_id": "0",
            "framework_id": "0",
            "candidate_framework": "",
            "consultant_name": "",
            "courses": "27,59,63,62,58,57,31,30,29,69,23,22,26,25,24,37,38,32,72,83,84,81,79,77,66,68,67,50,71,70,73,75,74,65,64,40,5,35,43,18,48,14,21,4,39,17,19,16,33,2,44,34,52,45,41,46,42,3,36,51,28,7,54,20,15,47,10,53,6",
            "training_charge": "client",
            "form_set": "clinical_occupational_health,driver_2_clinical_medical",
            "job_role": "",
            "clearance_type": "0",
            "return_email": "",
            "documents_required": "0",
            "document_list": "0",
            "date_registered": "2017-03-31 14:08:27",
            "last_login": "2023-05-19 08:11:16",
            "renewal_date": "2019-06-12 09:07:52",
            "assigned_course_count": "68",
            "completed_course_count": "9",
            "renewal_due_course_count": "0",
            "expired_course_count": "5"
        }
    }
]
Modified at 2024-08-09 12:12:32
Previous
Get All Candidates
Next
Create New Candidate
Built with