openapi: 3.2.0
info:
  title: Operations Hub Bamboohr.employees API
  version: 0.1.1
  description: ''
servers: []
tags:
- name: bamboohr.employees
paths:
  /api/bamboohr/v1/employees:
    get:
      operationId: list_bamboohr_employees
      summary: List BambooHR Employees
      parameters:
      - in: query
        name: search
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Search by display name, first/last name, or work email (case-insensitive).
          title: Search
        required: false
        description: Search by display name, first/last name, or work email (case-insensitive).
      - in: query
        name: sort
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Sort by field (prefix with - for descending)
          title: Sort
        required: false
        description: Sort by field (prefix with - for descending)
      - in: query
        name: status
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by employment status (ACTIVE, INACTIVE, TERMINATED)
          title: Status
        required: false
        description: Filter by employment status (ACTIVE, INACTIVE, TERMINATED)
      - in: query
        name: paginate
        schema:
          default: true
          description: Enable pagination (false returns all results)
          title: Paginate
          type: boolean
        required: false
        description: Enable pagination (false returns all results)
      - in: query
        name: page
        schema:
          default: 1
          description: Page number
          minimum: 1
          title: Page
          type: integer
        required: false
        description: Page number
      - in: query
        name: page_size
        schema:
          default: 50
          description: Number of items per page
          maximum: 1000
          minimum: 1
          title: Page Size
          type: integer
        required: false
        description: Number of items per page
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BambooHREmployeeResponse'
                title: Response
                type: array
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: List all items with optional search, sorting, and filtering.
      tags:
      - bamboohr.employees
      security:
      - APIKeyAuth: []
      - CookieAuth: []
components:
  schemas:
    Error:
      additionalProperties: false
      description: Error response schema.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          title: Message
          type: string
      required:
      - code
      - message
      title: Error
      type: object
    BambooHREmployeeResponse:
      additionalProperties: false
      description: Row in the BambooHR employees list endpoint.
      properties:
        updated_at:
          description: Last update timestamp
          format: date-time
          title: Updated At
          type: string
        id:
          description: Internal BambooHREmployee PK
          title: Id
          type: integer
        bamboohr_employee_id:
          description: External BambooHR employee ID (string)
          title: Bamboohr Employee Id
          type: string
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          description: Display name
          title: Display Name
        work_email:
          anyOf:
          - type: string
          - type: 'null'
          description: Work email
          title: Work Email
        status:
          anyOf:
          - type: string
          - type: 'null'
          description: Employment status (ACTIVE / INACTIVE / TERMINATED)
          title: Status
        cost_center:
          anyOf:
          - type: string
          - type: 'null'
          description: Cost center, mirrored from BambooHR's Cost Center (1) list
          title: Cost Center
        linked_resource_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: ID of the core.Resource currently linked to this employee, or null if unlinked. Frontends use this to disable already-linked options in the employee selector.
          title: Linked Resource Id
      required:
      - updated_at
      - id
      - bamboohr_employee_id
      title: BambooHREmployeeResponse
      type: object
    ErrorCode:
      description: Error codes for API errors.
      enum:
      - validation
      - server
      - auth
      - unknown
      - external
      - generic
      title: ErrorCode
      type: string
  securitySchemes:
    APIKeyAuth:
      type: http
      scheme: bearer
    CookieAuth:
      type: apiKey
      in: cookie
      name: opshub_prod_sessionid
    AuthBearer:
      type: http
      scheme: bearer