- 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
- Bookings
- Booking Links
- Registration Assurance Monitoring Portal
- Schemas
- TokenRequest
- Booking
- InterviewBooking
- TokenResponse
- Pagination
- RefreshRequest
- ReferenceRequest
- BookingInvite
- Reference
- BookingsResponse
- ReferenceDetail
- TokenInfo
- BookingLinksResponse
- CreateReferenceRequest
- Worker
- RefereeInput
- WorkerResponse
- Template
- WorkerPaginatedResponse
- WebhookEndpoint
- StoreWorkerRequest
- CreateWebhookEndpoint
- UpdateWorkerRequest
- VerificationCheck
- UpdateWebhookEndpoint
- WebhookCall
- VerificationCheckPaginatedResponse
- WebhookPayload
- VerifyQueuedResponse
- PaginationMeta
- VerifyBatchResponse
- PaginationLinks
- VerificationJobStatus
- Error
- Alert
- RateLimitError
- AlertPaginatedResponse
- MessageResponse
- BulkAcknowledgeAlertsRequest
- ValidationError
- ValidationErrorResponse
- AcknowledgeCountResponse
- UpdateMonitoringSettingsRequest
- BulkUpdateMonitoringSettingsRequest
- EvidenceFile
- EvidenceFilePaginatedResponse
- BillingUsageResponse
- StoreWorkerImportRequest
- WorkerImport
- WorkerImportPaginatedResponse
- TeamUser
- TeamUserPaginatedResponse
- StoreTeamUserRequest
- UpdateTeamUserRequest
- WebhookEndpointPaginatedResponse
- StoreWebhookEndpointRequest
- UpdateWebhookEndpointRequest
- CreateWebhookEndpointResponse
- RotateWebhookSecretResponse
- WebhookTestRequest
- WebhookTestQueuedResponse
- WebhookEventStatusChanged
- WebhookEventInitialVerification
Get All Candidates
GET
/candidates
Maintainer:Not configured
The request is HTTP GET (RFC2616).
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 --request GET '/candidates' \
--header 'Accept: application/json' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>' \
--data-urlencode 'per_page=10'Responses
🟢200Get All Candidates
application/json
Bodyapplication/json
Example
[
{
"candidates": [
{
"candidate_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"candidate_id": "0000000",
"client_record_ref": "",
"first_name": "first_name",
"last_name": "last_name",
"email": "email@domain.co.uk",
"candidate_status": "activated",
"date_registered": "2017-03-31 14:08:27",
"last_login_date": "2023-05-19 08:11:16",
"renewal_date": "2019-06-12 09:07:52",
"assigned_course_count": "68",
"completed_course_count": "9",
"renewal_due_count": "0",
"expired_course_count": "5",
"renew_training": "0"
},
{
"candidate_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"candidate_id": "0000000",
"client_record_ref": "",
"first_name": "first_name",
"last_name": "last_name",
"email": "email@domain.co.uk",
"candidate_status": "activated",
"date_registered": "2017-09-04 10:55:37",
"last_login_date": "2018-05-14 10:12:19",
"renewal_date": "2020-08-15 10:04:47",
"assigned_course_count": "21",
"completed_course_count": "0",
"renewal_due_count": "0",
"expired_course_count": "19",
"renew_training": "0"
}
]
}
]Modified at 2024-08-09 12:11:06