Skip to main content
GET
Get employee
employeeId identifies an employee record, not the linked Person. Repeating externalIdSystems in the query selects returned external IDs by system name. Omitting it returns all available authorized external IDs. Supported systems are payroll_system and hhaexchange. A requested system with no matching ID produces externalIds: []. An unsupported system returns 400 invalid_input with a message naming the value. A malformed employee UUID returns 400 invalid_input. An absent, archived, or out-of-scope employee returns 404 not_found. The shared Employee object includes top-level participation and coverage fields. Each is null when no applicable record exists.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

employeeId
string<uuid>
required

Employee-record UUID.

Query Parameters

externalIdSystems
string[]

Repeat for each system. This selects which external IDs are returned.

Response

Employee record.

asOf
string<date-time>
required
employee
object
required

Employee object. Participation and coverage are separate from membership.