> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hobbo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Heal.me Reviews

> This endpoint is used to fetch reviews from Heal.me for a specified practitioner or business.



## OpenAPI

````yaml POST /heal-me/reviews
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.hobbo.ai
    description: Main API server
  - url: https://py-api.hobbo.ai
    description: Python API server for scraper endpoints
security:
  - ApiKeyAuth: []
paths:
  /heal-me/reviews:
    post:
      description: >-
        This endpoint is used to fetch reviews from Heal.me for a specified
        practitioner or business.
      requestBody:
        description: Heal.me review scraping parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealMeReviewsRequest'
        required: true
      responses:
        '200':
          description: Reviews fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealMeReviewsResponse'
              examples:
                validationError:
                  value:
                    all_reviews: []
                    extra_information: {}
                    message: <string>
        '400':
          description: Validation error or unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validationError:
                  value:
                    error: <string>
      servers:
        - url: https://py-api.hobbo.ai
components:
  schemas:
    HealMeReviewsRequest:
      type: object
      required:
        - query
      properties:
        query:
          type: string
          description: Provide a proper Heal.me practitioner or business URL.
        is_text_formatted:
          type: boolean
          description: 'returns the review text with visual formatting preserved '
        sync_date:
          type: string
          description: 'Fetches reviews posted on a specific date using format: YYYY-MM-DD'
    HealMeReviewsResponse:
      type: object
      properties:
        all_reviews:
          type: array
          description: Array of fetched reviews
          items:
            type: object
            properties:
              appointment_id:
                type:
                  - string
                  - 'null'
                description: ID of the appointment if available
              author_id:
                type:
                  - string
                  - 'null'
                description: ID of the author if available
              author_name:
                type: string
                description: Name of the review author
              booking_count:
                type: integer
                description: Number of bookings the author has made
              client_confirmed_at:
                type:
                  - string
                  - 'null'
                description: Timestamp when the client confirmed the appointment
              client_id:
                type: integer
                description: ID of the client
              createdAtAgoInWords:
                type: string
                description: Human-readable time since the review was created
              created_at:
                type: string
                description: Timestamp when the review was created
              endorse_skill_ids:
                type:
                  - array
                  - 'null'
                description: IDs of endorsed skills if available
              helpful_count:
                type:
                  - integer
                  - 'null'
                description: Number of helpful votes if available
              isAnonymous:
                type: boolean
                description: Whether the review is anonymous
              is_practitioner:
                type:
                  - boolean
                  - 'null'
                description: Whether the reviewer is a practitioner
              is_require_client_confirmation:
                type:
                  - boolean
                  - 'null'
                description: Whether client confirmation is required
              kind:
                type: integer
                description: Type of review
              practice_id:
                type:
                  - string
                  - 'null'
                description: ID of the practice if available
              query:
                type: string
                description: Original query URL
              review_date:
                type: string
                description: Formatted date when the review was posted
              review_id:
                type: integer
                description: ID of the review
              review_rating:
                type: integer
                description: Rating given in the review (1-5)
              review_text:
                type: string
                description: Content of the review
              review_unique_id:
                type: string
                description: Unique identifier for the review
              token:
                type:
                  - string
                  - 'null'
                description: Token if available
              unverifiedName:
                type:
                  - string
                  - 'null'
                description: Unverified name if available
              updated_at:
                type:
                  - string
                  - 'null'
                description: Timestamp when the review was updated
              video_url:
                type:
                  - string
                  - 'null'
                description: URL to video review if available
        extra_information:
          type: object
          properties:
            extra_information:
              type: object
              description: Additional metadata about the reviews
            total_review_count:
              type: integer
              description: Total number of reviews fetched
            total_review_count_list:
              type: array
              items:
                type: integer
              description: List of review counts
        message:
          type: string
          description: Status message about the review extraction
    Error:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code
        data:
          type: object
          description: Empty object or additional error data
        success:
          type: boolean
          description: Indicates operation failed
          example: false
        message:
          type: string
          description: Error message describing what went wrong

````