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

# Get an employee

> Returns details about a single employee by their ID.



## OpenAPI

````yaml /simplifi_openapi.json get /employees/{employee_id}
openapi: 3.0.3
info:
  title: Simplifi API
  version: 1.0.0
  description: Workforce management API
  termsOfService: >-
    https://apps.staffsync.co.nz/static/StaffSyncUserTermsOfService.pdf?openexternal=true
  contact:
    name: Simplifi
    email: support@simplifi.work
    url: https://simplifi.work
servers:
  - url: https://{base_url}/api/v1
    description: Simplifi API Server
    variables:
      base_url:
        description: Your Simplifi instance base URL
        default: example.com
security:
  - BearerAuth: []
externalDocs:
  url: https://docs.simplifi.work/authentication
  description: The Simplifi API Documentation
paths:
  /employees/{employee_id}:
    get:
      tags:
        - Employees
      summary: Get an employee
      description: Returns details about a single employee by their ID.
      operationId: getEmployee
      parameters:
        - name: employee_id
          in: path
          description: The unique identifier of the employee to retrieve
          required: true
          schema:
            type: string
            example: '2095_1144974'
      responses:
        '200':
          description: Employee details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employee'
              example:
                id: '2095_1144974'
                address:
                  id: ''
                  city: Christchurch
                  country: ''
                  line1: 123 Fitzgerald Avenue
                  line2: ''
                  postalCode: 8011
                  state: Canterbury
                  suburb: ''
                contractedHours:
                  - id: '2443_312283'
                    day: 1
                    department:
                      id: '2784_119'
                      name: Deli
                    finishTime: null
                    minutesTotal: 480
                    minutesWorking: 480
                    role:
                      id: '2213_6559'
                      name: Retail Assistant
                    shift:
                      id: '2786_12120'
                      name: Morning
                    startTime: null
                    week: 1
                    workPattern: false
                  - id: '2443_312284'
                    day: 2
                    department:
                      id: '2784_119'
                      name: Deli
                    finishTime: T07:00:00.000
                    minutesTotal: 360
                    minutesWorking: 360
                    role:
                      id: '2213_6559'
                      name: Retail Assistant
                    shift: null
                    startTime: T01:00:00.000
                    week: 1
                    workPattern: false
                firstNames: Jane
                lastName: Smith
                payRollCode: ''
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    Employee:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the employee
          example: '2095_1144974'
        address:
          $ref: '#/components/schemas/Address'
        contractedHours:
          type: array
          description: A list of the employee's contracted hours entries across the week
          items:
            $ref: '#/components/schemas/ContractedHours'
        firstNames:
          type: string
          description: The employee's first name(s)
          example: Jane
        lastName:
          type: string
          description: The employee's last name
          example: Smith
        payRollCode:
          type: string
          description: >-
            The payroll code associated with this employee. Empty string if not
            assigned.
          example: ''
    Address:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the address. Empty string if not assigned.
          example: ''
        city:
          type: string
          description: City
          example: Christchurch
        country:
          type: string
          description: Country. Empty string if not assigned.
          example: ''
        line1:
          type: string
          description: First line of the address
          example: 123 Fitzgerald Avenue
        line2:
          type: string
          description: Second line of the address. Empty string if not assigned.
          example: ''
        postalCode:
          type: integer
          description: Postal/ZIP code
          example: 8011
        state:
          type: string
          description: State or region
          example: Canterbury
        suburb:
          type: string
          description: Suburb. Empty string if not assigned.
          example: ''
    ContractedHours:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for this contracted hours entry
          example: '2443_312283'
        day:
          type: integer
          description: The day of the week (1 = Monday, 7 = Sunday)
          example: 1
        department:
          $ref: '#/components/schemas/ContractedHoursDepartment'
        finishTime:
          type: string
          nullable: true
          description: >-
            The finish time of the contracted shift as a time-of-day value in T
            HH:MM:SS.mmm format (e.g. T07:00:00.000). Null if the shift is
            defined by a shift template rather than explicit times.
          example: T07:00:00.000
        minutesTotal:
          type: integer
          description: Total duration of the shift in minutes, including breaks
          example: 480
        minutesWorking:
          type: integer
          description: Working duration of the shift in minutes, excluding unpaid breaks
          example: 480
        role:
          $ref: '#/components/schemas/ContractedHoursRole'
        shift:
          allOf:
            - $ref: '#/components/schemas/ContractedHoursShift'
          nullable: true
          description: >-
            The shift template applied to this entry. Null if start/finish times
            are set explicitly.
        startTime:
          type: string
          nullable: true
          description: >-
            The start time of the contracted shift as a time-of-day value in T
            HH:MM:SS.mmm format (e.g. T01:00:00.000). Null if the shift is
            defined by a shift template rather than explicit times.
          example: T01:00:00.000
        week:
          type: integer
          description: The week number within the pay cycle this entry applies to
          example: 1
        workPattern:
          type: boolean
          description: Whether this entry is part of a work pattern
          example: false
    ContractedHoursDepartment:
      type: object
      description: A minimal department reference used within contracted hours
      properties:
        id:
          type: string
          description: The unique identifier of the department
          example: '2784_119'
        name:
          type: string
          description: The display name of the department
          example: Deli
    ContractedHoursRole:
      type: object
      description: A minimal role reference used within contracted hours
      properties:
        id:
          type: string
          description: The unique identifier of the role
          example: '2213_6559'
        name:
          type: string
          description: The display name of the role
          example: Retail Assistant
    ContractedHoursShift:
      type: object
      description: A minimal shift reference used within contracted hours
      properties:
        id:
          type: string
          description: The unique identifier of the shift
          example: '2786_12120'
        name:
          type: string
          description: The display name of the shift
          example: Morning
  responses:
    BadRequest:
      description: Bad Request - malformed request syntax or invalid parameters
    Unauthorized:
      description: Unauthorized - missing or invalid token
    Forbidden:
      description: Forbidden - valid token but insufficient permissions
    NotFound:
      description: Not Found - the requested resource does not exist
    Conflict:
      description: Conflict - the request conflicts with the current state of the resource
    UnprocessableEntity:
      description: >-
        Unprocessable Entity - the request was well-formed but contains semantic
        errors
    TooManyRequests:
      description: Too Many Requests - rate limit exceeded
    InternalServerError:
      description: Internal Server Error
    BadGateway:
      description: Bad Gateway - upstream service failed
    ServiceUnavailable:
      description: Service Unavailable
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtained from /oauth/token. Pass as Authorization: Bearer
        {token}

````