GET /v1/:facility_id/unit_groups
Shows all unit groups

Discussion

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

Examples

GET /v1/82cd30c4-abcd-4684-a87a-91dcc89cea2b/unit_groups
200
{
  "unit_groups": [
    {
      "id": "15d0584a-b009-476a-bdd7-28a79b6a1c59",
      "price": 50.0,
      "group_key": "100x100x100 - $50.00 - 3133 - [505] - 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": "f8eaad66-7c55-4225-a4cb-58fb3a3816c8",
          "name": "24 Hour Access",
          "short_code": "A16",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 505
        },
        {
          "id": "3a366b47-1aa5-4ca1-9419-d7a8dfde7de8",
          "name": "Climate Controlled",
          "short_code": "A17",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 506
        }
      ],
      "unit_type": {
        "id": "c91c40cb-d3fa-480d-a450-3ddb4eb27889",
        "name": "Unit Type 52",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "discount_plans": [],
      "channel_rate_ids": [],
      "available_upgrade_to_unit_groups": []
    },
    {
      "id": "62259f1d-dd6f-4efb-887a-59e4cb9f0ab2",
      "price": 50.0,
      "group_key": "1x1x1 - $50.00 - 3133 - 1",
      "name": "201 - Group",
      "available_units_count": 1,
      "total_units_count": 1,
      "total_non_excluded_units_count": 1,
      "size": "1x1x1",
      "standard_rate": 50.0,
      "floor": 1,
      "reduced_price": 50.0,
      "cyo_reduced_prices": {},
      "occupancy_percent": 0.0,
      "area": 1.0,
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "due_at_move_in": 50.0,
      "due_at_move_in_without_fees": 50.0,
      "due_monthly": 50.0,
      "attribute_description": "CEN",
      "description": "(CEN) - 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": [],
      "unit_type": {
        "id": "c91c40cb-d3fa-480d-a450-3ddb4eb27889",
        "name": "Unit Type 52",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "discount_plans": [],
      "channel_rate_ids": [],
      "available_upgrade_to_unit_groups": []
    },
    {
      "id": "809c923b-589e-4bc5-8dc1-cb1a0762207a",
      "price": 20.0,
      "group_key": "10x10x10 - $20.00 - 3133 - 1",
      "name": "301 - Group",
      "available_units_count": 1,
      "total_units_count": 1,
      "total_non_excluded_units_count": 1,
      "size": "10x10x10",
      "standard_rate": 20.0,
      "floor": 1,
      "reduced_price": 20.0,
      "cyo_reduced_prices": {},
      "occupancy_percent": 0.0,
      "area": 100.0,
      "length": 10.0,
      "width": 10.0,
      "height": 10.0,
      "due_at_move_in": 20.0,
      "due_at_move_in_without_fees": 20.0,
      "due_monthly": 20.0,
      "attribute_description": "CENM",
      "description": "(CENM) - 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": [],
      "unit_type": {
        "id": "c91c40cb-d3fa-480d-a450-3ddb4eb27889",
        "name": "Unit Type 52",
        "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": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 3,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "82cd30c4-abcd-4684-a87a-91dcc89cea2b",
      "unit_group": {}
    }
  }
}