openapi: 3.2.0
info:
  title: Hostfully Property Calendar 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: Property Calendar
paths:
  /api/v3.3/property-calendar/{propertyUid}:
    get:
      tags:
      - Property Calendar
      summary: Get property calendar
      description: Retrieves availability calendar for a specific property within a date range
      operationId: findByPropertyUid
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      - name: from
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: to
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: availabilityComments
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyCalendarApiResponseWrapper'
  /api/v3.3/property-calendar:
    get:
      tags:
      - Property Calendar
      summary: Get multiple property calendars
      description: Retrieves availability calendars for multiple properties within a specified date range
      operationId: findAll_4
      parameters:
      - name: propertiesUids
        in: query
        required: true
        schema:
          type: string
      - name: from
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: to
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: availabilityComments
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertiesCalendarsApiResponseWrapper'
components:
  schemas:
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    PropertyCalendarApiResponseWrapper:
      type: object
      properties:
        calendar:
          $ref: '#/components/schemas/CalendarApi3Dto'
    PropertiesCalendarsApiResponseWrapper:
      type: object
      properties:
        calendars:
          type: array
          items:
            $ref: '#/components/schemas/CalendarApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    CalendarEntryPricingApi3Dto:
      type: object
      properties:
        currency:
          type: string
          enum:
          - AED
          - ARS
          - AUD
          - BGN
          - BHD
          - BRL
          - CAD
          - CHF
          - CLP
          - CNY
          - COP
          - CZK
          - DKK
          - DOP
          - EUR
          - GBP
          - GTQ
          - HKD
          - HUF
          - IDR
          - IKR
          - ILS
          - INR
          - JPY
          - KES
          - KRW
          - MXN
          - MYR
          - NOK
          - NONE
          - NZD
          - PEN
          - PHP
          - PLN
          - RON
          - RUB
          - SEK
          - SGD
          - THB
          - TRY
          - TWD
          - USD
          - UYU
          - VEF
          - VND
          - VUV
          - JOD
          - SAR
          - EGP
          - ZAR
          - TTD
          - BBD
          - CVE
          - AWG
          - MAD
          - PYG
        value:
          type: number
    CalendarApi3Dto:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/CalendarEntryApi3Dto'
        propertyUid:
          type: string
    CalendarEntryAvailabilityApi3Dto:
      type: object
      properties:
        unavailable:
          type: boolean
        unavailabilityReason:
          type: string
          enum:
          - BOOKING
          - INQUIRY
          - BLOCK_BY_OWNER
          - BLOCK
          - PROPERTY_AVAILABILITY_SETTINGS
          - OTHER
        availableForCheckIn:
          type: boolean
        availableForCheckOut:
          type: boolean
        minimumStayLength:
          type: integer
          format: int32
        maximumStayLength:
          type: integer
          format: int32
        notes:
          type: array
          items:
            type: string
    CalendarEntryApi3Dto:
      type: object
      properties:
        date:
          type: string
          format: date
        note:
          type: string
        pricing:
          $ref: '#/components/schemas/CalendarEntryPricingApi3Dto'
        availability:
          $ref: '#/components/schemas/CalendarEntryAvailabilityApi3Dto'
        adjustedByCustomPricingPeriod:
          type: boolean
  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