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

# List Employees

> List employees for the org (newest first), excluding soft-deleted rows.



## OpenAPI

````yaml /api/openapi-cutmake.json get /api/v1/employees
openapi: 3.1.0
info:
  title: VM App API
  version: 0.1.0
servers:
  - url: https://vinmake-erp.onrender.com
security: []
paths:
  /api/v1/employees:
    get:
      tags:
        - 'Admin Sector: Employees'
      summary: List Employees
      description: List employees for the org (newest first), excluding soft-deleted rows.
      operationId: list_employees_api_v1_employees_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Limit
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Status
        - name: department
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Department
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Match name / code / email
            title: Search
          description: Match name / code / email
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEmployeeResponse'
        '401':
          description: Unauthorized
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    PaginatedEmployeeResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/EmployeeResponse'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/core__pagination__PaginationInfo'
      type: object
      required:
        - data
        - pagination
      title: PaginatedEmployeeResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EmployeeResponse:
      properties:
        id:
          type: string
          title: Id
        orgId:
          type: string
          title: Orgid
        employeeCode:
          anyOf:
            - type: string
            - type: 'null'
          title: Employeecode
        fullName:
          type: string
          title: Fullname
        preferredName:
          anyOf:
            - type: string
            - type: 'null'
          title: Preferredname
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
        department:
          anyOf:
            - type: string
            - type: 'null'
          title: Department
        jobTitle:
          anyOf:
            - type: string
            - type: 'null'
          title: Jobtitle
        employmentType:
          type: string
          title: Employmenttype
        status:
          type: string
          title: Status
        hireDate:
          anyOf:
            - type: string
            - type: 'null'
          title: Hiredate
        terminationDate:
          anyOf:
            - type: string
            - type: 'null'
          title: Terminationdate
        managerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Managerid
        linkedUserId:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkeduserid
        baseSalary:
          anyOf:
            - type: number
            - type: 'null'
          title: Basesalary
        payFrequency:
          anyOf:
            - type: string
            - type: 'null'
          title: Payfrequency
        notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Notes
        createdAt:
          anyOf:
            - type: string
            - type: 'null'
          title: Createdat
        updatedAt:
          anyOf:
            - type: string
            - type: 'null'
          title: Updatedat
      type: object
      required:
        - id
        - orgId
        - fullName
        - employmentType
        - status
      title: EmployeeResponse
    core__pagination__PaginationInfo:
      properties:
        page:
          type: integer
          title: Page
        limit:
          type: integer
          title: Limit
        total:
          type: integer
          title: Total
        totalPages:
          type: integer
          title: Totalpages
        hasNext:
          type: boolean
          title: Hasnext
        hasPrev:
          type: boolean
          title: Hasprev
      type: object
      required:
        - page
        - limit
        - total
        - totalPages
        - hasNext
        - hasPrev
      title: PaginationInfo
      description: |-
        Pagination metadata following API standards.

        Attributes:
            page: Current page number (1-indexed)
            limit: Items per page
            total: Total number of items matching query
            totalPages: Total number of pages
            hasNext: Whether there is a next page
            hasPrev: Whether there is a previous page
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/login

````