Skip to main content
GET
Error

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

Standard paginated response wrapper used by all list endpoints. Use pageNumber and size to paginate; stop when pageNumber >= totalPages.

​
size
integer<int32>
required

Maximum number of items per page as requested

Example:

10

​
totalElements
integer<int64>
required

Total number of items matching the query across all pages

Example:

42

​
totalPages
integer<int32>
required

Total number of pages based on totalElements / size

Example:

5

​
pageNumber
integer<int32>
required

Current page number, 1-based (first page = 1)

Example:

1

​
data
any[]
required

Items in the current page; may be fewer than size on the last page