openapi: 3.2.0
info:
  title: Hostfully Employees API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Employees
paths:
  /api/v3.3/employees/{employeeUid}:
    get:
      tags:
      - Employees
      summary: Get an employee
      description: Fetch detailed information about a single employee identified by their UID.
      operationId: getOne_7
      parameters:
      - name: employeeUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmployeeApiResponseWrapper'
    put:
      tags:
      - Employees
      summary: Update an employee
      description: Update information for the employee identified by the given UID with the provided data.
      operationId: put_8
      parameters:
      - name: employeeUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeApi3UpdatingDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmployeeApiResponseWrapper'
  /api/v3.3/employees:
    get:
      tags:
      - Employees
      summary: Get all agency employees
      description: Retrieve the list of active employees associated with the specified agency.
      operationId: getAll_11
      parameters:
      - name: agencyUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmployeesApiResponseWrapper'
components:
  schemas:
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    EmployeeApiResponseWrapper:
      type: object
      properties:
        employee:
          $ref: '#/components/schemas/EmployeeApi3Dto'
    EmployeesApiResponseWrapper:
      type: object
      properties:
        employees:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    EmployeeApi3Dto:
      type: object
      properties:
        uid:
          type: string
        agencyUid:
          type: string
        bestProfile:
          type: string
        email:
          type: string
        pictureUrl:
          type: string
        role:
          type: string
          enum:
          - MANAGER
          - BOOKING_AGENT
          - PROPERTY_SALES_MANAGER
          - ASSOCIATE
        firstName:
          type: string
        lastName:
          type: string
        phoneNumber:
          type: string
        phoneAreaCode:
          type: integer
          format: int32
        colorCode:
          type: string
    EmployeeApi3UpdatingDto:
      required:
      - firstName
      - lastName
      type: object
      properties:
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        colorCode:
          type: string
          description: Optional field, max size is 6
        phoneNumber:
          type: string
          description: Optional field, max size is 32
        phoneAreaCode:
          type: integer
          format: int32
        pictureUrl:
          type: string
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true