Skip to main content
POST
Search persons
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. Filters would combine with AND. Company, name, and phone filters must match the same authorized employment. They would select people, not trim a matching person’s returned employments array. The proposal returns each person once with all their employments in credential-authorized companies, including terminated records. Each employment is a complete Employee object with top-level participation and coverage. It paginates people rather than employments and sorts by Person createdAt then id. Employee records without a Person link remain available through Search employees. Response-size limits for complete employment arrays 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

Optional authorized company filter.

phone
string

Match on an authorized employment after normalization; accepted formats undecided.

firstName
string

Proposed case-insensitive partial match on an authorized employment.

lastName
string

Proposed case-insensitive partial match on an authorized employment.

personId
string<uuid>

Exact Person UUID match.

externalIdSystems
string[]

Selects returned external IDs; does not filter records.

createdFrom
string<date-time>

Inclusive Person creation-time lower bound.

createdBefore
string<date-time>

Exclusive Person 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 person search results.

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