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

# Retrieve all rental rates

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "title": "CiiRUS Partner API",
    "version": "2023.07.31"
  },
  "paths": {
    "/rates": {
      "get": {
        "summary": "Retrieve all rental rates",
        "description": "",
        "responses": {
          "200": {
            "description": "Inventory rates response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RetrieveRatesInventoryResponse"
                }
              }
            }
          },
          "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/ratesLength"
          },
          {
            "$ref": "#/components/parameters/start"
          },
          {
            "$ref": "#/components/parameters/lengthOfStay"
          },
          {
            "$ref": "#/components/parameters/deleted"
          },
          {
            "$ref": "#/components/parameters/fallbackRates"
          },
          {
            "$ref": "#/components/parameters/rangeMethod"
          },
          {
            "$ref": "#/components/parameters/minValue"
          },
          {
            "$ref": "#/components/parameters/maxValue"
          }
        ],
        "tags": [
          "Rates (Rental)"
        ]
      }
    }
  },
  "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
          }
        }
      },
      "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"
        }
      },
      "start": {
        "name": "start",
        "in": "query",
        "description": "The desired start for the availability check.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "lengthOfStay": {
        "name": "lengthOfStay",
        "in": "query",
        "description": "Use length of stay pricing if available.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "fallbackRates": {
        "name": "fallbackRates",
        "in": "query",
        "description": "Use length of stay pricing if available.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "rangeMethod": {
        "name": "rangeMethod",
        "in": "query",
        "description": "Sets range method when using length of stay.",
        "required": false,
        "schema": {
          "type": "integer"
        }
      },
      "maxValue": {
        "name": "maxValue",
        "in": "query",
        "description": "Sets max value for guards.",
        "required": false,
        "schema": {
          "type": "integer"
        }
      },
      "minValue": {
        "name": "minValue",
        "in": "query",
        "description": "Sets min value for guards.",
        "required": false,
        "schema": {
          "type": "integer"
        }
      },
      "deleted": {
        "name": "deleted",
        "in": "query",
        "description": "Only show properties which are deleted or not deleted.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "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
          }
        }
      },
      "ratesLength": {
        "name": "ratesLength",
        "in": "query",
        "description": "The desired length of the rates to be returned if it is available.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 1095,
          "default": 1095
        }
      }
    },
    "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"
        ]
      },
      "start": {
        "properties": {
          "start": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "length": {
        "properties": {
          "length": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "end": {
        "properties": {
          "end": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "property_id": {
        "properties": {
          "property_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique identifier for inventory"
          }
        }
      },
      "mc_user_id": {
        "properties": {
          "mc_user_id": {
            "type": "integer",
            "format": "int32",
            "description": "Unique Identifier for supplier"
          }
        }
      },
      "rate_set_id": {
        "properties": {
          "rate_set_id": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "nightly_rate": {
        "properties": {
          "nightly_rate": {
            "$ref": "#/components/schemas/NightlyRate"
          }
        }
      },
      "currency_exchanges": {
        "properties": {
          "currency_exchanges": {
            "$ref": "#/components/schemas/CurrencyExchange"
          }
        }
      },
      "iso_currency": {
        "properties": {
          "iso_currency": {
            "type": "string"
          }
        }
      },
      "RetrieveRatesInventoryResponse": {
        "properties": {
          "properties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RetrieveRatesResponseObject"
            }
          }
        },
        "required": [
          "properties"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/PagedLambdaResponseObject"
          },
          {
            "type": "object"
          }
        ]
      },
      "RetrieveRatesResponseObject": {
        "required": [
          "property_id",
          "rate_set_id",
          "nightly_rate",
          "currency_exchanges"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/property_id"
          },
          {
            "$ref": "#/components/schemas/rate_set_id"
          },
          {
            "$ref": "#/components/schemas/nightly_rate"
          },
          {
            "$ref": "#/components/schemas/currency_exchanges"
          },
          {
            "$ref": "#/components/schemas/mc_user_id"
          }
        ]
      },
      "NightlyRate": {
        "required": [
          "start",
          "end",
          "length",
          "iso_currency",
          "rates",
          "length_of_stay_pricing"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/start"
          },
          {
            "$ref": "#/components/schemas/end"
          },
          {
            "$ref": "#/components/schemas/length"
          },
          {
            "$ref": "#/components/schemas/iso_currency"
          },
          {
            "$ref": "#/components/schemas/rates"
          },
          {
            "$ref": "#/components/schemas/length_of_stay"
          },
          {
            "$ref": "#/components/schemas/length_of_stay_pricing"
          }
        ]
      },
      "CurrencyExchange": {
        "properties": {
          "iso_currency": {
            "type": "string"
          },
          "exchange_rate": {
            "type": "number",
            "multipleOf": 0.001
          }
        },
        "required": [
          "iso_currency",
          "exchange_rate"
        ]
      },
      "rates": {
        "properties": {
          "rates": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          }
        }
      },
      "length_of_stay": {
        "properties": {
          "length_of_stay": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "array",
                "items": {
                  "type": "number",
                  "multipleOf": 0.1
                }
              }
            }
          }
        }
      },
      "length_of_stay_pricing": {
        "properties": {
          "length_of_stay_pricing": {
            "type": "boolean"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```