openapi: 3.2.0
info:
  title: Hostfully Direct Booking Site API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
  description: 'Endpoint presenting read-only Hostfully''s Booking Site settings. More info at: https://help.hostfully.com/en/articles/4487522-activate-hostfully-channel'
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Direct Booking Site
  description: 'Endpoint presenting read-only Hostfully''s Booking Site settings. More info at: https://help.hostfully.com/en/articles/4487522-activate-hostfully-channel'
paths:
  /api/v3.3/dbs/properties/{propertyUid}:
    get:
      tags:
      - Direct Booking Site
      summary: Get property DBS settings
      description: Retrieves Direct Booking System (DBS) configuration for a specific property
      operationId: getPropertyDbsSettings
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DbsPropertyDtoWrapper'
  /api/v3.3/dbs/agencies/{agencyUid}:
    get:
      tags:
      - Direct Booking Site
      summary: Get agency DBS settings
      description: Retrieves Direct Booking System (DBS) configuration for a specific agency
      operationId: getAgencyDbsSettings
      parameters:
      - name: agencyUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgencyDbsResponseWrapper'
components:
  schemas:
    DBSAgencyPublicApiDto:
      type: object
      properties:
        agencyUid:
          type: string
        dbsEnabled:
          type: boolean
        website:
          type: string
        featuredProperties:
          type: array
          items:
            type: string
    AgencyDbsResponseWrapper:
      type: object
      properties:
        dbs:
          $ref: '#/components/schemas/DBSAgencyPublicApiDto'
    DbsPropertyDtoWrapper:
      type: object
      properties:
        dbs:
          $ref: '#/components/schemas/DBSPropertyDto'
    DBSPropertyDto:
      type: object
      properties:
        url:
          type: string
        enabled:
          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