WEwellhub
Employees

Find employee

Finds a single employee belonging to the authenticated single-entity client, by Eligibility Identifier.

post/v1/employees/find

Request

Request body

identifierstring required

The employee's Eligibility Identifier value, in the format configured for the company. Must match exactly what was submitted at ingestion — no normalization is applied. For a company configured with Employee ID and National ID, send only the employee_id value; omit national_id entirely.

Example request

{
  "identifier": "jane.doe@example.com"
}

Response

OK. Returns the matching employee.

idstring

Internal Wellhub identifier for the employee.

full_namestring

Employee's full name.

emailstring

Employee's email address.

employee_idstring

Client-defined employee identifier.

national_idstring

Employee's national identifier (e.g. CPF in Brazil).

invitation_statusstring

Current invitation status for the employee on the Wellhub platform.

cost_centerstring

Cost center associated with the employee.

departmentstring

Department the employee belongs to.

office_zip_codestring

ZIP code of the employee's office location.

payroll_idstring

Payroll identifier for the employee.

discount_subset_idstring nullable

Identifier for the discount subset applicable to this employee, if any.

employee_segmentstring nullable

Identifies the employee's segment for NR01, if set.

eligible_to_payrollboolean

Whether the employee is eligible for payroll deduction.

deleted_atstring date-time nullable

Timestamp when the employee record was soft-deleted. null if active.

updated_atstring date-time

Timestamp of the last update to this employee record.

Example response

{
  "id": "abc123def456",
  "full_name": "Jane Doe",
  "email": "jane.doe@example.com",
  "employee_id": "EMP001",
  "national_id": "123.456.789-00",
  "invitation_status": "accepted",
  "cost_center": "CC-001",
  "department": "Engineering",
  "office_zip_code": "01310-100",
  "payroll_id": "PAY-9876",
  "eligible_to_payroll": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.