GET /v1/:facility_id/unit_groups/:id
Shows a unit group by id

Discussion

If the facility has tiering enabled, then the "price" and "channel_rate" fields will be null in the response.

Params

Param name	Description
id required	Validations: Must be a String

Examples

GET /v1/96e7f9b8-0128-4461-9c42-0fc62a7343bd/unit_groups/e5520619-0714-4de5-845b-771f48408ee8
200
{
  "unit_group": {
    "id": "e5520619-0714-4de5-845b-771f48408ee8",
    "price": 50.0,
    "group_key": "100x100x100 - $50.00 - 3129 - [501] - 1",
    "name": "101 - Group",
    "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, Climate Controlled, 1st floor",
    "invoiceable_fees": [],
    "average_rent": 0.0,
    "active_rate_type": "standard_rate",
    "scheduled_move_outs": [],
    "managed_rate": null,
    "reservation_fee": null,
    "reference_unit_id": null,
    "channel_rate": null,
    "unit_amenities": [
      {
        "id": "e581d73b-3521-4b87-9aca-2c2e0b8152c5",
        "name": "24 Hour Access",
        "short_code": "A12",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 501
      },
      {
        "id": "f0605363-7d59-4c99-a4bf-7fdfcb42cbf5",
        "name": "Climate Controlled",
        "short_code": "A13",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 502
      }
    ],
    "unit_type": {
      "id": "89c89c45-2ffb-4f2d-8cf8-550fde03f59a",
      "name": "Unit Type 50",
      "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": "96e7f9b8-0128-4461-9c42-0fc62a7343bd",
      "id": "e5520619-0714-4de5-845b-771f48408ee8",
      "unit_group": {}
    }
  }
}