Get an onboarding by ID
Return the onboarding details for the given onboarding ID. stepProgress counts its steps through out of all of them: on ACTIONS its steps done, scheduled or skipped; otherwise the typed tasks of its ticket completed or cancelled (read them with getTicket). emails lists every email address of its employee, empty while the onboarding has no employee; the writes that return one onboarding (createOnboarding, completeOnboarding, ignoreOnboarding, executeOnboardingEquipment, startAgentOnboardingTicket) answer with the same field.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Path Parameters
Response
PENDING, SCHEDULED, IN_PROGRESS, CLOSED, CANCELED COCKPIT, MERGE, KOMBO, API ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$HR records from the connected HRIS (Kombo) for this onboarding
Every email address of the employee being onboarded. Empty while the onboarding has no employee.
How the onboarding holds its steps: ACTIONS (the onboarding steps and their plain tasks) or INTENTS (typed tasks under its ticket, run through the intent tools such as executeEmployeeCreationIntent). Null while it has neither a ticket nor a step, and for an onboarding run by the agent.
ACTIONS, INTENTS How many of its steps are through, out of how many: on ACTIONS its steps done, scheduled or skipped; otherwise the typed tasks of its ticket completed or cancelled. Null while it has no step.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$The hire an admin added by hand in the cockpit short form, before they are an employee in Primo