openapi: 3.2.0
info:
  title: Hostfully Units 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: Units
paths:
  /api/v3.3/multi-units/units/{uid}:
    get:
      tags:
      - Units
      summary: Get unit details
      description: Retrieves detailed information about a specific unit
      operationId: findUnitByUid
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UnitApiV3_1SingleResourceWrapper'
  /api/v3.3/multi-units/units:
    get:
      tags:
      - Units
      summary: List units by type
      description: Retrieves all units belonging to a unit type
      operationId: findUnitsByUnitType
      parameters:
      - name: unitTypeUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UnitApiV3_1AllResourcesWrapper'
components:
  schemas:
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    UnitApiV3_1Dto:
      type: object
      properties:
        uid:
          type: string
        Uid of a unit type:
          type: string
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        active:
          type: boolean
    UnitApiV3_1AllResourcesWrapper:
      type: object
      properties:
        units:
          type: array
          items:
            $ref: '#/components/schemas/UnitApiV3_1Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    UnitApiV3_1SingleResourceWrapper:
      type: object
      properties:
        unit:
          $ref: '#/components/schemas/UnitApiV3_1Dto'
  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