Get the onboarding settings
Return the company onboarding settings: which steps (email, SaaS provisioning, equipment) every onboarding includes, who owns each of them and when they are due, the scheduling of each step, the default ticket owner, priority and subscribers, whether the Primo AI agent is put on onboarding tickets or drives the equipment step, and when a hire detected in the HRIS gets its onboarding ticket. These settings shape every onboarding created afterwards, not the ones already open. Read this before updateOnboardingSettings so you can report what changes. For the settings of one onboarding already in flight, use getOnboarding instead.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Response
Whether the professional email step is part of every onboarding.
Whether the SaaS provisioning step is part of every onboarding.
Whether the equipment step is part of every onboarding.
Whether the Primo AI agent drives the equipment step instead of a human owner.
Whether the Primo AI agent is put on every onboarding ticket.
Whether ordered devices are enrolled in MDM automatically.
Whether Primo suggests SaaS applications for the joiner.
CREATE provisions a new address, EXISTING reuses the one the HRIS carries.
CREATE, EXISTING Steps Primo executes without waiting for an admin to validate them.
EMPLOYEE_INFORMATION, EMPLOYEE_EMAIL, EMPLOYEE_PROVISIONING, EMPLOYEE_EQUIPMENT Per-step overrides of owner, due date and scheduling.
When a hire detected in the HRIS gets its onboarding ticket: 30, 45 or 60 days before the start date (a hire detected later gets it right away), as soon as the HRIS shows the hire, or never automatically (MANUAL_ONLY, the ticket is then created by hand). Hires without a start date or starting in the past never get one automatically.
BEFORE_START_30_DAYS, BEFORE_START_45_DAYS, BEFORE_START_60_DAYS, ON_HRIS_DETECTION, MANUAL_ONLY USE_AS_IS, MANUAL_CONFIRMATION Assignee of the onboarding ticket and of every step with no owner of its own. Null means unassigned.
LOW, MEDIUM, HIGH