Skip to main content
GET
Get the offboarding 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
offboardingTicketCreation
enum<string> | null
required

When an offboarding ticket opens: 1, 7 or 30 days before the last day, as soon as the HRIS shows the departure, or never automatically (MANUAL_ONLY). Null when the company never chose.

Available options:
BEFORE_LAST_DAY_1_DAY,
BEFORE_LAST_DAY_7_DAYS,
BEFORE_LAST_DAY_30_DAYS,
ON_HRIS_DETECTION,
MANUAL_ONLY
pastOffboardingWindow
string
required

How far back the HRIS sync records a departure already past as an offboarding; DISABLED for none.

defaultTaskOwner
object | null
required

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

defaultTaskPriority
string | null
required
defaultTaskSubscribers
object[]
required

Who follows every offboarding ticket.

stepSettings
object[]
required

One entry per step, in order; a step the company never set reads included, MANUAL, with no date.

manualDeprovisioningDueDays
number | null
required

Days an application owner has to remove an account by hand.

returnShipmentPolicy
enum<string> | null
required

Whether the equipment comes back by a return shipment: always, decided per offboarding, or never.

Available options:
ALWAYS,
PER_OFFBOARDING,
NEVER
equipmentDefaults
object | null
required
idpSettings
object[]
required

Per email provider (Google Workspace, Microsoft 365): the account action and the transfer targets.