openapi: 3.2.0
info:
  title: Hostfully Property Ownership 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 Ownership
paths:
  /api/v3.3/property-ownership/{propertyUid}:
    get:
      tags:
      - Property Ownership
      summary: View the owner of a property.
      operationId: getOne_4
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyOwnershipApiResponseWrapper'
    delete:
      tags:
      - Property Ownership
      summary: Delete the owner of a property.
      operationId: delete_4
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
    patch:
      tags:
      - Property Ownership
      summary: Set or modify the owner of a property.
      operationId: patch
      parameters:
      - name: propertyUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyOwnershipApi3Dto'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PropertyOwnershipApiResponseWrapper'
components:
  schemas:
    PropertyOwnershipOwnerApi3Dto:
      type: object
      properties:
        uid:
          type: string
        email:
          type: string
          description: Optional field, max size 191
        firstName:
          type: string
          description: Optional field, max size is 255
        lastName:
          type: string
          description: Optional field, max size is 255
        phoneNumberAreaCode:
          type: integer
          format: int32
        phoneNumber:
          type: string
          description: Optional field, max size is 32
        businessName:
          type: string
          description: Optional field, max size is 255
        pictureUrl:
          type: string
        preferredLocale:
          type: string
          enum:
          - en_US
          - fr_FR
          - es_ES
          - it_IT
          - de_DE
          - nl_NL
          - pt_PT
          - no_NO
          - pl_PL
        lastLoginUtcDateTime:
          type: string
          example: '2026-04-20T11:52:36'
        invitationSent:
          type: boolean
          description: Indicates whether an invitation for the owner to claim the account has been sent.
        ccEmails:
          type: string
        agencyCommissionRate:
          type: number
        permissionTypes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
            - READING_CALENDAR
            - READING_BOOKING_DETAILS
            - READING_BOOKING_VALUE
            - CREATING_BLOCKS
            - VIEW_ANALYTICS
        formula:
          type: string
          enum:
          - DEFAULT
          - RENTAL_REVENUE
          - RENTAL_REVENUE_AND_CLEANING_FEE
          - RENTAL_REVENUE_MINUS_AGENCY_COMMISSION
    PropertyOwnershipApiResponseWrapper:
      type: object
      properties:
        propertyOwnership:
          $ref: '#/components/schemas/PropertyOwnershipApi3Dto'
    PropertyOwnershipApi3Dto:
      type: object
      properties:
        propertyUid:
          type: string
        owner:
          $ref: '#/components/schemas/PropertyOwnershipOwnerApi3Dto'
        copyOwnerWhenBookingConfirmed:
          type: boolean
        collectAndRemitTaxes:
          type: boolean
        ownerNotes:
          type: string
          description: Notes for the owner. It's the field of a property resource, therefore editing it results in editing property.
  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