openapi: 3.2.0
info:
  title: Hostfully Reviews 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: Reviews
paths:
  /api/v3.3/reviews/{reviewUid}:
    get:
      tags:
      - Reviews
      summary: Get review details
      description: Retrieves details of a specific guest review
      operationId: getOne_3
      parameters:
      - name: reviewUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ReviewApiResponseWrapper'
    put:
      tags:
      - Reviews
      summary: Update guest review
      description: Completely replaces a guest review's content
      operationId: put_4
      parameters:
      - name: reviewUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewUpdatingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ReviewApiResponseWrapper'
    delete:
      tags:
      - Reviews
      summary: Delete guest review
      description: Removes a guest review from the system
      operationId: delete_3
      parameters:
      - name: reviewUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /api/v3.3/reviews:
    get:
      tags:
      - Reviews
      summary: List guest reviews
      description: Retrieves paginated guest reviews for a property or lead
      operationId: getAll_4
      parameters:
      - name: propertyUid
        in: query
        required: false
        schema:
          type: string
      - name: leadUid
        in: query
        required: false
        schema:
          type: string
      - name: source
        in: query
        required: false
        schema:
          type: string
          enum:
          - BOOKING_DOT_COM
          - VRBO
          - FACEBOOK
          - TRIPADVISOR
          - REVYOOS
          - HOSTFULLY
      - name: sort
        in: query
        required: false
        schema:
          type: string
          enum:
          - SORT_BY_RATING
          - SORT_BY_DATE
          - SORT_BY_AUTHOR
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: updatedSince
        in: query
        required: false
        schema:
          type: string
          example: '2023-09-28T10:31:01'
        example: '2023-09-28T10:31:01'
      - name: _cursor
        in: query
        description: Cursor for pagination
        required: false
        schema:
          type: string
          description: Cursor for pagination
      - name: _limit
        in: query
        description: Limit for pagination
        required: false
        schema:
          type: string
          description: Limit for pagination
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ReviewsApiResponseWrapper'
    post:
      tags:
      - Reviews
      summary: Create guest review
      description: Creates a new guest review for a property
      operationId: post_5
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReviewAddingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ReviewApiResponseWrapper'
  /api/v3.3/reviews/statistics:
    get:
      tags:
      - Reviews
      summary: Get review statistics
      description: Retrieves review statistics and analytics for a property
      operationId: getStatistics
      parameters:
      - name: propertyUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ReviewStatisticsApiResponseWrapper'
components:
  schemas:
    ReviewStatisticsApi3Dto:
      type: object
      properties:
        totalReviewsCount:
          type: integer
          format: int32
        averageRating:
          type: number
          format: double
    ReviewResponseApi3Dto:
      type: object
      properties:
        content:
          type: string
        author:
          type: string
        responseDateTimeUTC:
          type: string
          example: '2026-04-20T11:52:36'
    ReviewUpdatingApi3Dto:
      required:
      - date
      type: object
      properties:
        author:
          type: string
        title:
          type: string
        content:
          type: string
        rating:
          type: integer
          format: int32
        date:
          type: string
          format: date
        source:
          type: string
        privateFeedback:
          type: string
        reviewResponse:
          $ref: '#/components/schemas/ReviewResponseAddingApi3Dto'
        ratingCategories:
          type: array
          items:
            $ref: '#/components/schemas/ReviewRatingCategoryApi3Dto'
    ReviewStatisticsApiResponseWrapper:
      type: object
      properties:
        statistics:
          $ref: '#/components/schemas/ReviewStatisticsApi3Dto'
    ReviewResponseAddingApi3Dto:
      type: object
      properties:
        content:
          type: string
        author:
          type: string
    ReviewsApiResponseWrapper:
      type: object
      properties:
        reviews:
          type: array
          items:
            $ref: '#/components/schemas/ReviewApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
        _paging:
          $ref: '#/components/schemas/Api3ResponsePaging'
    ReviewApiResponseWrapper:
      type: object
      properties:
        review:
          $ref: '#/components/schemas/ReviewApi3Dto'
    ReviewAddingApi3Dto:
      required:
      - author
      - content
      - date
      - propertyUid
      - title
      type: object
      properties:
        propertyUid:
          type: string
        leadUid:
          type: string
        author:
          type: string
        title:
          type: string
        content:
          type: string
        rating:
          type: integer
          format: int32
        date:
          type: string
          format: date
        source:
          type: string
        privateFeedback:
          type: string
        reviewResponse:
          $ref: '#/components/schemas/ReviewResponseAddingApi3Dto'
        ratingCategories:
          type: array
          items:
            $ref: '#/components/schemas/ReviewRatingCategoryApi3Dto'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    ReviewRatingCategoryApi3Dto:
      type: object
      properties:
        category:
          type: string
          enum:
          - ACCURACY
          - CLEANLINESS
          - CHECKIN
          - COMMUNICATION
          - LOCATION
          - VALUE
        rate:
          type: integer
          format: int32
        comment:
          type: string
    Api3ResponsePaging:
      type: object
      properties:
        _limit:
          type: integer
          format: int32
        _nextCursor:
          type: string
    ReviewApi3Dto:
      type: object
      properties:
        uid:
          type: string
        author:
          type: string
        title:
          type: string
        content:
          type: string
        rating:
          type: integer
          format: int32
        date:
          type: string
          format: date
        propertyUid:
          type: string
        leadUid:
          type: string
        source:
          type: string
        privateFeedback:
          type: string
        reviewResponse:
          $ref: '#/components/schemas/ReviewResponseApi3Dto'
        ratingCategories:
          type: array
          items:
            $ref: '#/components/schemas/ReviewRatingCategoryApi3Dto'
        updatedUtcDateTime:
          type: string
          example: '2026-04-20T11:52:36'
  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