Skip to main content
GET
Get all onboardings
Key: Read Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
perPage
number
default:50

Number of items per page (max 100)

Required range: 1 <= x <= 100
ticketId
string

Only the onboarding this ticket tracks (its onboarding ticket).

Pattern: ^[a-f\d]{24}$
employeeId
string

Only the onboardings of this Primo employee.

Pattern: ^[a-f\d]{24}$
status
enum<string>

Only the onboardings in this status.

Available options:
PENDING,
SCHEDULED,
IN_PROGRESS,
CLOSED,
CANCELED

A first name, a last name or an email, or part of one, of the employee, of the HRIS record or of the hire added by hand; case-insensitive, matched against each field on its own, so one word, not a full name.

Minimum string length: 1

Response

default - application/json
data
object[]
required
pagination
object
required