Examples

GET /v1/fc065dee-2fc7-46fd-9c31-0417430f17ba/unit_groups/c4345b83-d0d1-444d-98ad-df5da6d73465
200
{
  "unit_group": {
    "id": "c4345b83-d0d1-444d-98ad-df5da6d73465",
    "price": 50.0,
    "group_key": "100x100x100 - $50.00 - 2116 - [197] - 1",
    "name": "100x100x100 - $50.00 - 2116 - [197] - 1",
    "available_units_count": 5,
    "total_units_count": 5,
    "total_non_excluded_units_count": 5,
    "size": "100x100x100",
    "standard_rate": 50.0,
    "floor": 1,
    "reduced_price": 50.0,
    "cyo_reduced_prices": {},
    "occupancy_percent": 0.0,
    "area": 10000.0,
    "length": 100.0,
    "width": 100.0,
    "height": 100.0,
    "due_at_move_in": 50.0,
    "due_at_move_in_without_fees": 50.0,
    "due_monthly": 50.0,
    "attribute_description": "CDN",
    "description": "(CDN) - 24 Hour Access, 1st floor",
    "invoiceable_fees": [],
    "average_rent": 0.0,
    "active_rate_type": "standard_rate",
    "scheduled_move_outs": [],
    "managed_rate": null,
    "reservation_fee": null,
    "tiering": {
      "cross_sell_group_id": 2058,
      "descriptor": "No Tier",
      "justification": null,
      "tiered_amenities": []
    },
    "channel_rate": null,
    "unit_amenities": [
      {
        "id": "d4064472-2826-4026-956a-96d2c4469acc",
        "name": "24 Hour Access",
        "short_code": "A16",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 197
      }
    ],
    "unit_type": {
      "id": "b29a9347-cfaf-41f5-85dd-011e909db5e7",
      "name": "Unit Type 143",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    "discount_plans": [],
    "channel_rate_ids": [],
    "available_upgrade_to_unit_groups": []
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "fc065dee-2fc7-46fd-9c31-0417430f17ba",
      "id": "c4345b83-d0d1-444d-98ad-df5da6d73465"
    }
  }
}

Params

Param name Description
id
required

Value: Must be a String