Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Query Parameters

page
integer<int32>
default:1

Page number (1-based)

Required range: x >= 1
Example:

1

size
integer<int32>
default:25

Page size (1–200)

Required range: 1 <= x <= 200
Example:

25

sortBy
string

Sort field: startDate, urgency, equipmentReadiness, employee, country, personStatus, estimatedDeliveryDate, reminderCount, lastReminderSentAt, provisioningOutcome, orderDate

Example:

"startDate"

sortDirection
string

Sort direction (ASC, DESC)

Example:

"ASC"

searchString
string

Free-text search across name and email

equipmentReadiness
enum<string>[]

Filter by equipment readiness: NOT_STARTED, ORDER_PLACED, READY

Filter by equipment readiness: NOT_STARTED, ORDER_PLACED, READY

Available options:
NOT_STARTED,
ORDER_PLACED,
READY
urgency
enum<string>[]

Filter by urgency: ON_TRACK, AT_RISK, LATE

Filter by urgency: ON_TRACK, AT_RISK, LATE

Available options:
ON_TRACK,
AT_RISK,
LATE
countryCodes
string[]

Filter by ISO country codes

Filter by ISO country codes

provisioningOutcome
enum<string>[]

Filter by provisioning outcome: ON_TIME, LATE

Filter by provisioning outcome: ON_TIME, LATE

Available options:
ON_TIME,
LATE
startDateFrom
string<date>

Start date lower bound (ISO-8601). When omitted, a default 60-day lookback floor is applied. Supply explicitly to widen the window.

Example:

"2026-01-01"

startDateTo
string<date>

Start date upper bound (ISO-8601)

Example:

"2026-12-31"

userStatus
enum<string>[]

Filter by person status: INVITED, ACTIVE, INACTIVE, etc.

Filter by person status: INVITED, ACTIVE, INACTIVE, etc.

Available options:
INVITED,
ACTIVE,
INACTIVE,
DELETED,
OFFBOARDING,
CANNOT_REACTIVATE
procurementMethod
enum<string>[]

Filter by procurement method: WAREHOUSE, DROPSHIP, MIXED

Filter by procurement method: WAREHOUSE, DROPSHIP, MIXED

Available options:
DROPSHIP,
MIXED,
WAREHOUSE

Response

New joiners retrieved successfully

person
object
required

The person (new joiner) this onboarding row belongs to.

equipmentReadiness
enum<string>
required

Indicates whether the equipment for this new joiner is ready for deployment.

Available options:
NOT_STARTED,
ORDER_PLACED,
READY
reminderCount
integer<int32>
required

The total number of onboarding reminder notifications sent for this new joiner.

orderRef
object

Lightweight reference to this new joiner's equipment provisioning order (maps to the internal GraphQL order field). Null when the joiner has not been ordered yet; use GET /api/orders/{id} for full order details.

urgency
enum<string>

Urgency classification for this new joiner's equipment pipeline. ON_TRACK, AT_RISK, or LATE when the pipeline is still in progress. Null once provisioningOutcome is set — the pipeline has resolved and urgency no longer applies.

Available options:
ON_TRACK,
AT_RISK,
LATE
provisioningOutcome
enum<string>

The outcome of the equipment provisioning process for this new joiner.

Available options:
ON_TIME,
LATE
provisioningOutcomeDate
string<date>

Calendar date when equipment was delivered (order path) or inventory was assigned (inventory path). Same date the backend used to compute provisioningOutcome. Null when equipmentReadiness is not READY or no date could be derived.

Example:

"2026-05-01"

provisioningOutcomeSource
enum<string>

Identifies which data source produced provisioningOutcomeDate. ORDER_DELIVERY: date comes from the latest deliveryDate on a computer order line. INVENTORY_ASSIGNMENT: date comes from the audit-derived deployedAt for deployed computer inventory. Null when provisioningOutcomeDate is null.

Available options:
ORDER_DELIVERY,
INVENTORY_ASSIGNMENT
estimatedDeliveryDate
string<date>

The estimated date on which the new joiner's equipment will be delivered.

lastReminder
object

The date and time the last onboarding reminder notification was sent.

procurementMethod
enum<string>

How this new joiner's equipment is fulfilled. WAREHOUSE when all computer lines are sourced from inventory, DROPSHIP when all are shipped directly from a vendor, MIXED when both methods are used. Null when no computer lines have a fulfilment record yet.

Available options:
WAREHOUSE,
DROPSHIP,
MIXED