Skip to main content
GET
Get employee
Coming soon — unavailable in sandbox and production. The code sample uses the current Partner API host for illustration; the final hostname and contract are undecided. Do not send requests to this route. employeeId identifies an employee record, not the linked Person. Repeating externalIdSystems in the query would select returned external IDs by system name; omitting it would return all available authorized external IDs. A requested system with no matching ID would produce externalIds: []. The shared Employee object includes top-level participation and coverage fields. Each is null when no applicable record exists. Which record to return when an employment has multiple plan programs remains undecided. Complete error responses remain draft.

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; selects which external IDs are returned.

Response

200 - application/json

Proposed employee record.

asOf
string<date-time>
required
employee
object
required

Draft shared Employee object. Participation and coverage are separate from membership; record selection across multiple plan programs is pending.