Retrieves a list of onboardings for a specified company.

If the current user is a limited Client Admin (i.e., not a Full Admin), the result set is filtered based on onboarding limitations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The ID of the company.

Query Params
int32
enum

Optional. The type of onboarding to filter by. This can be a combination of the following values:
NewEe: New Employee Onboarding (value = 1)
RehireEe: Rehire Employee Onboarding (value = 2)
GlobalEe: Global Employee Onboarding (value = 4)
GlobalRehireEe: Rehire Employee Onboarding (value = 8)
New1099: 1099 Employee Onboarding (value = 16)
Multiple values can be combined using a comma or by summing up values, e.g., "1,4" or "5" to filter by both NewEe and GlobalEe.

Allowed:
int32
enum

Optional. The status of onboarding to filter by. This can be a combination of the following values:
Created: Onboarding was created. (value = 1)
ReadyForStart: Employer can start Phase 1 (value = 2)
Phase1InProgress: Employer is filling Phase 1 (value = 4)
WaitingForEe: Employer finished Phase 1 and onboarding is waiting for employee start (value = 8)
Phase2InProgress: Employee is filling Phase 2 (value = 16)
InVerification: Employer is verifying onboarding - Phase 3 (value = 32)
Finished: Onboarding was finished and employee was created (value = 64)
Multiple values can be combined using a comma or by summing up values, e.g., "1,4" or "5" to filter by both Created and Phase1InProgress.

Allowed:
date-time

Optional. Filters onboardings created on or after this date.

date-time

Optional. Filters onboardings created on or before this date.

date-time

Optional. Filters onboardings finished on or after this date.

date-time

Optional. Filters onboardings finished on or before this date.

date-time

Optional. Filters onboardings with a hire date on or after this date.

date-time

Optional. Filters onboardings with a hire date on or before this date.

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json