- Walk through Healthier Business Group 🔵
- Heathier Business Portal APIs V2
- Authentication
- Reference Requests
- Candidate Requests
- Training Requests
- OH Requests
- Practical Training Requests
- BLS Requests
- Appraisal Requests
- Certificate Requests
- Training Verification Requests
- Webhooks
- Templates
- Heathier Business Portal APIs V1 - Deprecated
- Candidate Requests
- Training Requests
- OH Requests
- Certificates Requests
- Webhooks
- HB Services
- The Direct Training Academy
- Schemas
- Booking
- TokenResponse
- InterviewBooking
- Pagination
- BookingInvite
- ReferenceRequest
- BookingsResponse
- Reference
- BookingLinksResponse
- ReferenceDetail
- CreateReferenceRequest
- RefereeInput
- Template
- WebhookEndpoint
- CreateWebhookEndpoint
- UpdateWebhookEndpoint
- WebhookCall
- WebhookPayload
- PaginationMeta
- PaginationLinks
- Error
- RateLimitError
- ValidationError
Get reference request
GET
/reference-requests/{uuid}
Maintainer:Not configured
Request
Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************or
Path 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 '/reference-requests/' \
--header 'Authorization: Bearer <token>'Responses
🟢200
application/json
Body
Example
{
"data": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"candidate_id": 0,
"candidate_name": "John Doe",
"candidate_email": "user@example.com",
"template_id": 0,
"template_name": "string",
"collection_mode": "client_adds",
"status": "pending",
"status_label": "In Progress",
"references_required": 2,
"references_completed": 1,
"is_fully_referenced": true,
"notes": "string",
"expires_at": "2019-08-24T14:15:22.123Z",
"is_expired": true,
"requested_by": 0,
"submission_url": "string",
"references": [
{
"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"
}
],
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z"
}
}🟠404
Modified at 2026-02-17 18:56:15