Skip to main content
GET
Error

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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

Stats retrieved successfully

Aggregate counts for the new joiner dashboard status cards and provisioning outcomes

​
totalUpcoming
integer<int32>
required

Total upcoming new joiners (active pipeline only)

Example:

42

​
notStarted
integer<int32>
required

New joiners with no order placed yet

Example:

10

​
orderPlaced
integer<int32>
required

New joiners with an order placed but not yet ready

Example:

15

​
ready
integer<int32>
required

New joiners whose equipment is ready

Example:

12

​
atRisk
integer<int32>
required

New joiners at risk (start date approaching, equipment not ready)

Example:

3

​
late
integer<int32>
required

New joiners who are late (start date passed, equipment not ready)

Example:

2

​
onTimeProvisioningCount
integer<int32>
required

Count of new joiners provisioned on time

Example:

38

​
lateProvisioningCount
integer<int32>
required

Count of new joiners provisioned late

Example:

4