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

# Get the caller's profile overview.



## OpenAPI

````yaml /api-reference/portal.v1.json get /api/v1/portal/employee
openapi: 3.0.3
info:
  title: Swiss HR Easy — Employee Portal API
  version: 1.0.0
  description: >-
    Versioned contract for the employee self-service portal endpoints consumed
    by the mobile app. Generated from Zod schemas — do not edit by hand (run
    `npm run gen:openapi`).
servers:
  - url: https://{tenantHost}
    description: >-
      Per-tenant deployment host. Swiss HR Easy is single-tenant, so each
      customer install serves this contract from its own host.
security: []
tags:
  - name: profile
    description: Employee profile overview and entitlements.
  - name: leave
    description: Employee leave balances and requests.
  - name: time
    description: Employee time tracking and weekly summaries.
  - name: sick-leave
    description: Employee sick-leave reports and summaries.
  - name: payslips
    description: Employee payslips and deduction breakdowns.
  - name: compensation
    description: The caller's compensation role, salary band and placement rationale.
  - name: auth
    description: Current-session retrieval and logout for the mobile app.
  - name: holidays
    description: >-
      The days behind the vacation day count that cost less than a full day:
      public holidays, school holidays, and Betriebsferien days the caller was
      approved to work through.
paths:
  /api/v1/portal/employee:
    get:
      tags:
        - profile
      summary: Get the caller's profile overview.
      operationId: getEmployeeProfile
      responses:
        '200':
          description: The caller's profile overview.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/EmployeeOverviewDTO'
        '401':
          description: The caller is not authenticated.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
        '404':
          description: No employee record is linked to the caller's account.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
components:
  schemas:
    EmployeeOverviewDTO:
      type: object
      properties:
        id:
          type: string
        employeeNumber:
          nullable: true
          type: string
        userName:
          type: string
        userEmail:
          type: string
        department:
          nullable: true
          type: string
        jobTitle:
          nullable: true
          type: string
        location:
          nullable: true
          type: object
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
        manager:
          nullable: true
          type: object
          properties:
            name:
              type: string
          required:
            - name
          additionalProperties: false
        status:
          type: string
          enum:
            - PREBOARDING
            - ONBOARDING
            - ACTIVE
            - ON_LEAVE
            - OFFBOARDING
            - TERMINATED
        startDate:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\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))$
        workloadPercent:
          type: number
        canton:
          nullable: true
          type: string
        probationEndDate:
          nullable: true
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\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))$
        workingWeekdays:
          type: array
          items:
            type: string
            enum:
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
              - SUNDAY
        followsSchoolCalendar:
          type: boolean
        onboarding:
          nullable: true
          type: object
          properties:
            status:
              type: string
              enum:
                - NOT_STARTED
                - IN_PROGRESS
                - COMPLETED
            totalTasks:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            completedTasks:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - status
            - totalTasks
            - completedTasks
          additionalProperties: false
      required:
        - id
        - employeeNumber
        - userName
        - userEmail
        - department
        - jobTitle
        - location
        - manager
        - status
        - startDate
        - workloadPercent
        - canton
        - probationEndDate
        - workingWeekdays
        - followsSchoolCalendar
        - onboarding
      additionalProperties: false

````