> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprimo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the offboarding settings

> Return the company offboarding settings: when an offboarding ticket opens (`offboardingTicketCreation`), how far back the HRIS sync records a past departure, the default ticket owner, priority and subscribers, and for each step (the confirmation, the access removal, the device handling, the return shipment) whether it is included, whether Primo runs it (AUTOMATIC) or its owner does (MANUAL), its owner and its day and time from the last day. Also the days an application owner has to remove an account by hand, the return shipment policy, the default device handling with the MDM action per platform (`equipmentDefaults.mdmActions`: a lock, a wipe or nothing), and per email provider the mailbox action and who receives the files and the emails (`idpSettings`). A classic offboarding runs from these settings; an offboarding run by the Offboarding Agent runs from its instructions instead. To read the onboarding settings, use `getOnboardingSettings`.

Key: ReadScope: Company


## OpenAPI

````yaml https://api.getprimo.com/openapi.json get /offboarding-settings
openapi: 3.1.1
info:
  title: Public API - BETA
  description: Read docs on https://docs.getprimo.com/
  version: '1.0'
  contact: {}
servers:
  - url: https://api.getprimo.com
security:
  - apikey: []
tags: []
paths:
  /offboarding-settings:
    get:
      tags:
        - Offboardings
      summary: Get the offboarding settings
      description: >-
        Return the company offboarding settings: when an offboarding ticket
        opens (`offboardingTicketCreation`), how far back the HRIS sync records
        a past departure, the default ticket owner, priority and subscribers,
        and for each step (the confirmation, the access removal, the device
        handling, the return shipment) whether it is included, whether Primo
        runs it (AUTOMATIC) or its owner does (MANUAL), its owner and its day
        and time from the last day. Also the days an application owner has to
        remove an account by hand, the return shipment policy, the default
        device handling with the MDM action per platform
        (`equipmentDefaults.mdmActions`: a lock, a wipe or nothing), and per
        email provider the mailbox action and who receives the files and the
        emails (`idpSettings`). A classic offboarding runs from these settings;
        an offboarding run by the Offboarding Agent runs from its instructions
        instead. To read the onboarding settings, use `getOnboardingSettings`.
      operationId: getOffboardingSettings
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OffboardingSettings_Output'
components:
  schemas:
    OffboardingSettings_Output:
      type: object
      properties:
        offboardingTicketCreation:
          description: >-
            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.
          anyOf:
            - type: string
              enum:
                - BEFORE_LAST_DAY_1_DAY
                - BEFORE_LAST_DAY_7_DAYS
                - BEFORE_LAST_DAY_30_DAYS
                - ON_HRIS_DETECTION
                - MANUAL_ONLY
            - type: 'null'
        pastOffboardingWindow:
          type: string
          description: >-
            How far back the HRIS sync records a departure already past as an
            offboarding; DISABLED for none.
        defaultTaskOwner:
          description: >-
            Assignee of the offboarding ticket and of every step with no owner
            of its own. Null means unassigned.
          anyOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - EMPLOYEE
                    - EXTERNAL_ADMIN
                employeeId:
                  description: 'With EMPLOYEE: the Primo employee id, for `getEmployee`'
                  anyOf:
                    - type: string
                    - type: 'null'
                userId:
                  description: >-
                    With EXTERNAL_ADMIN: the admin user id, as `getAdmins` lists
                    it
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - type
                - employeeId
                - userId
              additionalProperties: false
            - type: 'null'
        defaultTaskPriority:
          anyOf:
            - type: string
            - type: 'null'
        defaultTaskSubscribers:
          type: array
          description: Who follows every offboarding ticket.
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - EMPLOYEE
                  - EXTERNAL_ADMIN
              employeeId:
                description: 'With EMPLOYEE: the Primo employee id, for `getEmployee`'
                anyOf:
                  - type: string
                  - type: 'null'
              userId:
                description: >-
                  With EXTERNAL_ADMIN: the admin user id, as `getAdmins` lists
                  it
                anyOf:
                  - type: string
                  - type: 'null'
            required:
              - type
              - employeeId
              - userId
            additionalProperties: false
        stepSettings:
          type: array
          description: >-
            One entry per step, in order; a step the company never set reads
            included, MANUAL, with no date.
          items:
            type: object
            properties:
              stepType:
                type: string
                enum:
                  - OFFBOARDING_CONFIRMATION
                  - OFFBOARDING_ACCESS_SELECTION
                  - DEVICE_HANDLING
                  - RETURN_SHIPMENT
              included:
                description: Whether every offboarding runs this step.
                type: boolean
              autonomy:
                description: >-
                  AUTOMATIC: Primo runs the step on its date; MANUAL: its owner
                  runs it.
                type: string
                enum:
                  - MANUAL
                  - AUTOMATIC
              owner:
                description: Owner of the step. Falls back to `defaultTaskOwner`.
                anyOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - EMPLOYEE
                          - EXTERNAL_ADMIN
                      employeeId:
                        description: >-
                          With EMPLOYEE: the Primo employee id, for
                          `getEmployee`
                        anyOf:
                          - type: string
                          - type: 'null'
                      userId:
                        description: >-
                          With EXTERNAL_ADMIN: the admin user id, as `getAdmins`
                          lists it
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - type
                      - employeeId
                      - userId
                    additionalProperties: false
                  - type: 'null'
              dayOffset:
                description: >-
                  Days from the last day the step happens on, negative before
                  it.
                anyOf:
                  - type: number
                  - type: 'null'
              time:
                description: Time of day the step happens at, as "HH:mm", Europe/Paris.
                anyOf:
                  - type: string
                  - type: 'null'
            required:
              - stepType
              - included
              - autonomy
              - owner
              - dayOffset
              - time
            additionalProperties: false
        manualDeprovisioningDueDays:
          description: Days an application owner has to remove an account by hand.
          anyOf:
            - type: number
            - type: 'null'
        returnShipmentPolicy:
          description: >-
            Whether the equipment comes back by a return shipment: always,
            decided per offboarding, or never.
          anyOf:
            - type: string
              enum:
                - ALWAYS
                - PER_OFFBOARDING
                - NEVER
            - type: 'null'
        equipmentDefaults:
          anyOf:
            - type: object
              properties:
                deviceRecycle:
                  description: >-
                    What happens to a device: back in stock, reassigned,
                    retired.
                  anyOf:
                    - type: string
                    - type: 'null'
                mdmActions:
                  description: >-
                    The MDM action on the data of a device, per platform: a
                    lock, a wipe or nothing.
                  type: array
                  items:
                    type: object
                    properties:
                      platform:
                        type: string
                      action:
                        type: string
                        enum:
                          - SOFT_WIPE
                          - HARD_WIPE
                          - WIPE
                          - LOCK
                          - NOTHING
                    required:
                      - platform
                      - action
                    additionalProperties: false
                accessoryRecycle:
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - deviceRecycle
                - mdmActions
                - accessoryRecycle
              additionalProperties: false
            - type: 'null'
        idpSettings:
          type: array
          description: >-
            Per email provider (Google Workspace, Microsoft 365): the account
            action and the transfer targets.
          items:
            type: object
            properties:
              companySaasApplicationId:
                description: The email provider, for `getSaasById`
                type: string
              accountAction:
                description: What happens to the mailbox account
                type: string
                enum:
                  - SUSPEND
                  - DELETE
                  - DO_NOTHING
              fileTransferTarget:
                description: Who receives the leaver's files
                anyOf:
                  - type: object
                    properties:
                      type:
                        description: >-
                          MANAGER: the leaver's manager at the time; USER:
                          `employeeId`
                        type: string
                        enum:
                          - MANAGER
                          - USER
                      employeeId:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - type
                      - employeeId
                    additionalProperties: false
                  - type: 'null'
              emailForwardingTarget:
                description: Who receives the leaver's emails
                anyOf:
                  - type: object
                    properties:
                      type:
                        description: >-
                          MANAGER: the leaver's manager at the time; USER:
                          `employeeId`
                        type: string
                        enum:
                          - MANAGER
                          - USER
                      employeeId:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - type
                      - employeeId
                    additionalProperties: false
                  - type: 'null'
            required:
              - companySaasApplicationId
              - accountAction
              - fileTransferTarget
              - emailForwardingTarget
            additionalProperties: false
      required:
        - offboardingTicketCreation
        - pastOffboardingWindow
        - defaultTaskOwner
        - defaultTaskPriority
        - defaultTaskSubscribers
        - stepSettings
        - manualDeprovisioningDueDays
        - returnShipmentPolicy
        - equipmentDefaults
        - idpSettings
      additionalProperties: false
  securitySchemes:
    apikey:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: >-
        Use your Primo API key in the Authorization header as `Bearer
        <API_KEY>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.