Skip to main content
POST
Search employees
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. Search filters would combine with AND. externalIdSystems would select the external IDs returned in each Employee object; it would not filter records. The proposal includes terminated records, preserves duplicate employee records, and sorts by createdAt then id. Pagination reads live data. Full Social Security numbers would not be returned. Each Employee object includes top-level participation and coverage fields. Each is null when no applicable record exists. Phone normalization formats, name matching, and selection across multiple plan programs remain undecided.

Authorizations

Authorization
string
header
required

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

Body

application/json
companyId
string
required

Required authorized company ID.

phone
string

Exact match after normalization; accepted formats undecided.

firstName
string

Proposed case-insensitive partial match.

lastName
string

Proposed case-insensitive partial match.

personId
string<uuid>

Exact Person UUID match.

externalIdSystems
string[]

Selects returned external IDs; does not filter records.

createdFrom
string<date-time>

Inclusive creation-time lower bound.

createdBefore
string<date-time>

Exclusive creation-time upper bound.

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

200 - application/json

Proposed employee search results.

asOf
string<date-time>
required
employees
object[]
required
pagination
object
required