Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. Workers
  • 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
  • The Direct Training Academy
    • Bookings
      • Get Past Bookings
      • Get Upcoming Bookings
      • Search Bookings by Date
    • Booking Links
      • Search Booking Links
  • Registration Assurance Monitoring Portal
    • Authentication
      • Obtain access token
      • Refresh access token
      • Get token info
      • Revoke current token
    • Workers
      • List workers
        GET
      • Create worker
        POST
      • Get worker
        GET
      • Update worker
        PUT
      • Partially update worker
        PATCH
      • Delete worker
        DELETE
    • Verification
      • Verify single worker
      • Get worker verification history
      • Batch verify all workers
      • Get verification job status
    • Alerts
      • List alerts
      • Get alert
      • Acknowledge single alert
      • Acknowledge alerts in bulk
    • Monitoring
      • Update worker monitoring settings
      • Bulk update monitoring settings
    • Evidence
      • List worker evidence files
      • Get evidence metadata
      • Download evidence file
    • Billing
      • Get billing and usage summary
    • Imports
      • List worker imports
      • Upload worker CSV import
      • Get worker import status
    • Team
      • List available team roles
      • List team users
      • Create team user
      • Get team user
      • Update team user
      • Delete team user
    • Webhooks
      • List webhook endpoints
      • Create webhook endpoint
      • Get webhook endpoint
      • Update webhook endpoint
      • Delete webhook endpoint
      • Rotate webhook secret
      • Queue test webhook delivery
  • 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
  1. Workers

List workers

GET
/v1/workers
Maintainer:Not configured
Returns a paginated list of workers belonging to the authenticated client. Results are ordered by last name.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
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 '/v1/workers?regulator=undefined&status=undefined&is_active=undefined&page=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
Paginated list of workers
Bodyapplication/json

Example
{
    "data": [
        {
            "id": 101,
            "first_name": "Jane",
            "last_name": "Smith",
            "date_of_birth": "1985-06-15",
            "email": "jane.smith@example.com",
            "phone": "07700900123",
            "regulator": "nmc",
            "registration_number": "SW12345",
            "profession": "Social Worker",
            "current_status": "active",
            "expiry_date": "2027-06-30",
            "restrictions_summary": null,
            "monitoring_start_date": "2026-04-21",
            "check_frequency": "daily",
            "last_checked_at": "2026-04-21T08:30:00+00:00",
            "next_check_due_at": "2026-04-28T08:30:00+00:00",
            "consent_given": true,
            "consent_given_at": "2026-04-21T09:00:00+00:00",
            "is_active": true,
            "notes": "Senior social worker, team lead",
            "created_at": "2026-04-21T09:00:00+00:00",
            "updated_at": "2026-04-21T11:30:00+00:00"
        }
    ],
    "links": {
        "first": "https://ram.test/api/v1/workers?page=1",
        "last": "https://ram.test/api/v1/workers?page=4",
        "prev": null,
        "next": "https://ram.test/api/v1/workers?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
        "per_page": 50,
        "to": 50,
        "total": 187
    }
}
🟠401Unauthorized
Modified at 2026-04-24 12:59:02
Previous
Revoke current token
Next
Create worker
Built with