Skip to main content
GET
Get the onboarding settings
Key: Read Scope: Company

Authorizations

Authorization
string
header
required

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

Response

default - application/json
emailIncluded
boolean
required

Whether the professional email step is part of every onboarding.

provisioningIncluded
boolean
required

Whether the SaaS provisioning step is part of every onboarding.

equipmentIncluded
boolean
required

Whether the equipment step is part of every onboarding.

equipmentHandledByAi
boolean
required

Whether the Primo AI agent drives the equipment step instead of a human owner.

addPrimoAiAgent
boolean
required

Whether the Primo AI agent is put on every onboarding ticket.

equipmentMdmEnrollment
boolean
required

Whether ordered devices are enrolled in MDM automatically.

saasApplicationSuggestions
boolean
required

Whether Primo suggests SaaS applications for the joiner.

emailCreationChoice
enum<string>
required

CREATE provisions a new address, EXISTING reuses the one the HRIS carries.

Available options:
CREATE,
EXISTING
automaticProcessingActions
enum<string>[]
required

Steps Primo executes without waiting for an admin to validate them.

Available options:
EMPLOYEE_INFORMATION,
EMPLOYEE_EMAIL,
EMPLOYEE_PROVISIONING,
EMPLOYEE_EQUIPMENT
defaultTaskSubscribers
object[]
required
taskSettings
object[]
required

Per-step overrides of owner, due date and scheduling.

emailExistingAddressHandling
enum<string> | null
Available options:
USE_AS_IS,
MANUAL_CONFIRMATION
emailScheduling
object | null
provisioningScheduling
object | null
equipmentScheduling
object | null
defaultTaskOwner
object | null

Assignee of the onboarding ticket and of every step with no owner of its own. Null means unassigned.

defaultTaskPriority
enum<string> | null
Available options:
LOW,
MEDIUM,
HIGH