---
updatedAt: 2025-09-09T21:11:45.000Z
agentTools:
  projectIndex: https://docs.ciiruspartners.com/v2023.07.31/llms.txt
---

# Retrieve all reviews

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2023.07.31"
  },
  "paths": {
    "/reviews": {
      "get": {
        "summary": "Retrieve all reviews",
        "description": "",
        "responses": {
          "200": {
            "description": "Reviews response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RetrieveAllReviewsResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/lastUpdateDate"
          },
          {
            "$ref": "#/components/parameters/mcUserId"
          },
          {
            "$ref": "#/components/parameters/mcUserIds"
          },
          {
            "$ref": "#/components/parameters/unitIdQuery"
          },
          {
            "$ref": "#/components/parameters/unitIdQueries"
          },
          {
            "$ref": "#/components/parameters/reviewStart"
          },
          {
            "$ref": "#/components/parameters/reviewEnd"
          },
          {
            "$ref": "#/components/parameters/arrivalStart"
          },
          {
            "$ref": "#/components/parameters/arrivalEnd"
          },
          {
            "$ref": "#/components/parameters/departureStart"
          },
          {
            "$ref": "#/components/parameters/departureEnd"
          },
          {
            "$ref": "#/components/parameters/reviewIdQuery"
          },
          {
            "$ref": "#/components/parameters/reviewIdQueries"
          },
          {
            "$ref": "#/components/parameters/reservationIdQuery"
          },
          {
            "$ref": "#/components/parameters/reservationIdQueries"
          }
        ],
        "tags": [
          "Reviews"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.ciiruspartners.com/v2023.07.31"
    }
  ],
  "components": {
    "parameters": {
      "unitIdQuery": {
        "name": "unitId",
        "in": "query",
        "description": "Unique Identifier for inventory.",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "unitIdQueries": {
        "name": "unitIds",
        "in": "query",
        "description": "Unique Identifiers for inventory.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "reviewIdQuery": {
        "name": "reviewId",
        "in": "query",
        "description": "Unique Identifier for review.",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "reviewIdQueries": {
        "name": "reviewIds",
        "in": "query",
        "description": "Unique Identifiers for reviews.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "reservationIdQuery": {
        "name": "reservationId",
        "in": "query",
        "description": "Unique Identifier for reservation.",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "reservationIdQueries": {
        "name": "reservationIds",
        "in": "query",
        "description": "Unique Identifiers for reservations.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      },
      "pageSize": {
        "name": "pageSize",
        "in": "query",
        "description": "Limits the number of returned results.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 1000,
          "default": 25
        }
      },
      "page": {
        "name": "page",
        "in": "query",
        "description": "The page to be shown.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "default": 1
        }
      },
      "lastUpdateDate": {
        "name": "lastUpdateDate",
        "in": "query",
        "description": "Only return objects which have been modified after a certain date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "arrivalStart": {
        "name": "arrivalStart",
        "in": "query",
        "description": "Only return reservations which arrive after a certain date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "arrivalEnd": {
        "name": "arrivalEnd",
        "in": "query",
        "description": "Only return reservations which arrive before a certain date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "reviewStart": {
        "name": "reviewStart",
        "in": "query",
        "description": "Only return reviews which were made after a certain date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "reviewEnd": {
        "name": "reviewEnd",
        "in": "query",
        "description": "Only return reservations which were made before a certain date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "departureStart": {
        "name": "departureStart",
        "in": "query",
        "description": "Only return reservations which depart after a certain date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "departureEnd": {
        "name": "departureEnd",
        "in": "query",
        "description": "Only return reservations which depart before a certain date.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "mcUserId": {
        "name": "mcUserId",
        "in": "query",
        "description": "Unique Identifier for supplier.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0
        }
      },
      "mcUserIds": {
        "name": "mcUserIds",
        "in": "query",
        "description": "Unique Identifiers for suppliers.",
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found response",
        "content": {
          "*/*": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ]
      },
      "PagedLambdaResponseObject": {
        "properties": {
          "next_page_url": {
            "type": "string",
            "format": "uri",
            "description": "URL to the next page (not present on last page)"
          },
          "previous_page_url": {
            "type": "string",
            "format": "uri",
            "description": "URL to the previous page (not present on first page)"
          },
          "total_page_count": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "description": "Total number of pages available"
          }
        },
        "required": [
          "total_page_count"
        ]
      },
      "applicable_taxes": {
        "properties": {
          "applicable_taxes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/applicable_tax"
            }
          }
        }
      },
      "applicable_tax": {
        "required": [
          "tax_type"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/tax_type"
          }
        ]
      },
      "rate_decimal_places": {
        "properties": {
          "rate_decimal_places": {
            "type": "integer"
          }
        }
      },
      "amount": {
        "properties": {
          "amount": {
            "type": "integer"
          }
        }
      },
      "item_code": {
        "properties": {
          "item_code": {
            "type": "string"
          }
        }
      },
      "item_id": {
        "properties": {
          "item_id": {
            "type": "string"
          }
        }
      },
      "property_id": {
        "properties": {
          "property_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique identifier for inventory"
          }
        }
      },
      "airbnb_fee_type": {
        "properties": {
          "airbnb_fee_type": {
            "type": "string",
            "enum": [
              "PASS_THROUGH_RESORT_FEE,",
              "PASS_THROUGH_MANAGEMENT_FEE,",
              "PASS_THROUGH_COMMUNITY_FEE,",
              "PASS_THROUGH_LINEN_FEE,",
              "PASS_THROUGH_ELECTRICITY_FEE,",
              "PASS_THROUGH_WATER_FEE,",
              "PASS_THROUGH_HEATING_FEE,",
              "PASS_THROUGH_AIR_CONDITIONING_FEE,",
              "PASS_THROUGH_UTILITY_FEE,",
              "PASS_THROUGH_PET_FEE,",
              "PASS_THROUGH_CLEANING_FEE,",
              "PASS_THROUGH_SHORT_TERM_CLEANING_FEE,",
              "PASS_THROUGH_SECURITY_DEPOSIT"
            ]
          }
        }
      },
      "fee_type": {
        "properties": {
          "fee_type": {
            "type": "string",
            "enum": [
              "CLEANING_FEE,",
              "BOOKING_FEE,",
              "STANDARD_DISCOUNT",
              "OPTIONAL_EXTRA",
              "MANDATORY_EXTRA",
              "POOL_HEAT_FEE",
              "ON_ARRIVAL_EXTRA",
              "SECURITY_DEPOSIT"
            ]
          }
        }
      },
      "mc_user_id": {
        "properties": {
          "mc_user_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique Identifier for supplier"
          }
        }
      },
      "fees": {
        "properties": {
          "fees": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/fee"
            }
          }
        }
      },
      "fee": {
        "allOf": [
          {
            "$ref": "#/components/schemas/property_id"
          },
          {
            "$ref": "#/components/schemas/fee_type"
          },
          {
            "$ref": "#/components/schemas/amount"
          },
          {
            "$ref": "#/components/schemas/rate_decimal_places"
          },
          {
            "$ref": "#/components/schemas/applicable_taxes"
          },
          {
            "$ref": "#/components/schemas/airbnb_fee_type"
          },
          {
            "$ref": "#/components/schemas/item_code"
          },
          {
            "$ref": "#/components/schemas/item_id"
          }
        ],
        "required": [
          "property_id",
          "fee_type",
          "applicable_taxes"
        ]
      },
      "RetrieveAllReviewsResponse": {
        "properties": {
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RetrieveReviewsResponseObject"
            }
          }
        },
        "required": [
          "properties"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/PagedLambdaResponseObject"
          },
          {
            "type": "object"
          }
        ]
      },
      "RetrieveReviewsResponseObject": {
        "allOf": [
          {
            "$ref": "#/components/schemas/property_id"
          },
          {
            "$ref": "#/components/schemas/fees"
          },
          {
            "$ref": "#/components/schemas/mc_user_id"
          }
        ],
        "required": [
          "property_id",
          "fees",
          "mc_user_id"
        ]
      },
      "tax_type": {
        "properties": {
          "tax_type": {
            "type": "string",
            "enum": [
              "TAX_ONE,",
              "TAX_TWO,",
              "TAX_THREE"
            ]
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```