Units (Facility Level)
Unit information

Examples

GET /v1/8b6c4928-e58b-4725-ab24-85a70872040b/units
200
{
  "units": [
    {
      "id": "fd703724-69bb-4581-9d20-ac2185d5b9cf",
      "price": 764.95,
      "name": "U131",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "ec25d5ca-c85b-4729-bd1d-cae099bfed4b",
        "name": "Unit Type 161",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "ab9561bb-61ac-46f1-8fae-068f22672785"
    },
    {
      "id": "92ab7a43-ee86-44ec-880d-41c6d0e21430",
      "price": 764.95,
      "name": "U132",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "7b2b34b5-928e-4ace-ac3d-12e8e709ea1b",
        "name": "Unit Type 162",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "639b3c41-82f5-41a6-b55e-37e81338699e"
    },
    {
      "id": "47081503-d361-4aa3-8a4e-d0fd7f1b5e62",
      "price": 764.95,
      "name": "U133",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "0a7308b8-5ad6-4f4f-8405-cef086c2bf32",
        "name": "Unit Type 163",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "14a8bf5f-4997-4f57-842b-65197137bd94"
    },
    {
      "id": "54360d8c-af69-4fe4-981b-07b30cc3caf9",
      "price": 764.95,
      "name": "U134",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "e2b9d263-c5a1-4dde-bb8d-7b318a0cc801",
        "name": "Unit Type 164",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "02020b93-5ee7-4252-8777-9ec69f37aef8"
    },
    {
      "id": "576fb3f4-9fbb-41de-977e-729bac904e37",
      "price": 764.95,
      "name": "U135",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "ee7fd31d-ab04-4edd-82e1-292f2e43735b",
        "name": "Unit Type 165",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "0dd5f629-011b-47ac-abd3-64f07540e711"
    },
    {
      "id": "c88c9598-2308-4afa-b5c6-2cd33ab77cb4",
      "price": 764.95,
      "name": "U136",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "48b1eca7-5d04-49ba-8c48-423b4c813f11",
        "name": "Unit Type 166",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "a2511d71-7902-4e5c-9920-28e7b1fc6ae1"
    },
    {
      "id": "fb6813cb-ac91-4423-9350-8a632f0714c7",
      "price": 764.95,
      "name": "U137",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "5c698daa-18d0-4205-b886-d1e517686665",
        "name": "Unit Type 167",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "b15cf34c-1be2-4757-9094-ef1fa80b14fe"
    },
    {
      "id": "8f17b341-595e-4dcc-ab4c-253f89f26759",
      "price": 764.95,
      "name": "U138",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "72d7a906-9688-4e94-b716-5e99101b75b6",
        "name": "Unit Type 168",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "d2f2549f-0a97-40e8-8565-b8f760dd28b7"
    },
    {
      "id": "1776c7b7-b061-490e-8b53-81f46791c0a3",
      "price": 764.95,
      "name": "U139",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "e9a3c32e-b0ea-46e5-a74d-2154ee04d7dd",
        "name": "Unit Type 169",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "b9c5f214-0f9b-4c3c-a05b-b305ebcc8472"
    },
    {
      "id": "79430831-33c1-4348-be7f-1d85c3e32e17",
      "price": 764.95,
      "name": "U141",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": false,
      "rentable": true,
      "status": "occupied",
      "payment_status": "current",
      "current_ledger_id": "94595dd0-5338-4e6d-8494-c47f5b1b49c7",
      "current_tenant_id": "b8855aca-eb52-49f1-baaa-05f78c27421b",
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": false,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "13827596-2926-4f1a-90f2-c733a69ae048",
        "name": "Unit Type 171",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "3d836e77-4419-4c37-8913-f57a594765c7"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 10,
      "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": "8b6c4928-e58b-4725-ab24-85a70872040b",
      "unit": {}
    }
  }
}

Allowed values for door_type

• none
• roll_up
• swing

Allowed values for access_type

• indoor
• outdoor

Params

Examples

GET /v1/bc4b6da9-8872-4eda-b258-ccb95d6b332f/units/875190d0-70e2-4317-bd1d-9b573e4aa4e6
200
{
  "unit": {
    "id": "875190d0-70e2-4317-bd1d-9b573e4aa4e6",
    "price": 764.95,
    "name": "U163",
    "description": "",
    "width": 10.0,
    "length": 6.0,
    "height": 4.0,
    "door_height": 10.0,
    "door_width": 1.0,
    "door_type": "roll_up",
    "access_type": "indoor",
    "floor": null,
    "directions": null,
    "size": "10x6x4",
    "area": 60.0,
    "standard_rate": 764.95,
    "managed_rate": null,
    "tiered_rate": null,
    "available_for_move_in": false,
    "rentable": true,
    "status": "occupied",
    "payment_status": "current",
    "current_ledger_id": "df2c974d-5d13-41e4-b5e0-b2b0a35b1999",
    "current_tenant_id": "ac8c2191-6697-49ed-b926-2d81a833e992",
    "combo_lock_group": null,
    "combination_lock_number": null,
    "overlock_lock_number": null,
    "attribute_description": null,
    "deleted": false,
    "damaged": false,
    "complimentary": false,
    "unrentable": false,
    "company_owned": false,
    "is_prepped": null,
    "rank": null,
    "custom_fields": [],
    "allow_future_move_ins_limit": null,
    "channel_rate": null,
    "unit_amenities": [],
    "unit_type": {
      "id": "9fb79d89-e241-401f-97a4-fa1188346a85",
      "name": "Unit Type 193",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    "tier": null,
    "unit_group_id": "3762fdd6-0ac9-4f62-98c4-32bf1e297824"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "bc4b6da9-8872-4eda-b258-ccb95d6b332f",
      "id": "875190d0-70e2-4317-bd1d-9b573e4aa4e6",
      "unit": {}
    }
  }
}

Examples

GET /v1/a9df6d89-06cb-4a26-99d5-4f7e72aadd52/units/available
200
{
  "units": [
    {
      "id": "3b0f9ac6-e9e9-4358-a3e6-e37c551680eb",
      "price": 764.95,
      "name": "U175",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "223e67fa-5b99-4aef-9d65-7e51bcc8bb37",
        "name": "Unit Type 205",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "2cc0b069-0b2e-4e49-a1d2-a19ce131cbc9"
    },
    {
      "id": "ecf338c9-d725-4bf2-9cd2-428fde1c7e52",
      "price": 764.95,
      "name": "U176",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "81b9bcdf-cd91-42a5-ab86-9666fc0b34e6",
        "name": "Unit Type 206",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "d69b9a50-141b-43c6-9fec-3ebd3dcd4e7d"
    },
    {
      "id": "c9dba07c-4bfb-4e2d-becd-726d04f2579a",
      "price": 764.95,
      "name": "U177",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "237d7dcd-780e-45ab-bdca-4f5dc0a8bc04",
        "name": "Unit Type 207",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "2266c66f-c579-4f7e-9c73-598802a39768"
    },
    {
      "id": "5a7f9622-b4f3-4ef1-8da3-18119aa4d321",
      "price": 764.95,
      "name": "U178",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "fcc24a18-9457-43ee-8a2e-8208a7278266",
        "name": "Unit Type 208",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "f1651c86-3f9a-4cfe-a5be-9da549f2df32"
    },
    {
      "id": "5d2f8835-6645-4b5a-9881-d51feafc4152",
      "price": 764.95,
      "name": "U179",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "42a72086-461a-49a7-bad4-a8e71dbbd0ef",
        "name": "Unit Type 209",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "5e22148e-c6bc-44f2-b3c2-d63097c0cec7"
    },
    {
      "id": "6a7bb7c3-0a1b-4fb6-b2e4-67dd8614cdb7",
      "price": 764.95,
      "name": "U180",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "25272d93-9dee-45ea-ae81-802152cad7a1",
        "name": "Unit Type 210",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "a5420b9e-d7d8-414d-a6b8-0c67350887d2"
    },
    {
      "id": "16dc8b8c-b0db-4c8e-8cd9-c1afac3bbda9",
      "price": 764.95,
      "name": "U181",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "1662b510-7633-4e7a-b306-74f2ec4c1cea",
        "name": "Unit Type 211",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "d11c1172-4a07-451c-9c36-11ff777e0e32"
    },
    {
      "id": "22f56c74-8567-406e-bc1f-05e4ad89b3b0",
      "price": 764.95,
      "name": "U182",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "ebb52576-e288-4ef6-b39a-77000b415256",
        "name": "Unit Type 212",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "26ee9022-eafa-4163-b7c2-536f158fe991"
    },
    {
      "id": "f45a0421-1531-4c3f-8a7f-e3df53376657",
      "price": 764.95,
      "name": "U183",
      "description": "",
      "width": 10.0,
      "length": 6.0,
      "height": 4.0,
      "door_height": 10.0,
      "door_width": 1.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "10x6x4",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "1f31ef97-2e86-4487-93c3-7037b0dfc45e",
        "name": "Unit Type 213",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "3cd70f0f-1c9b-4321-a4d4-ea008c8c06e3"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 9,
      "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": "a9df6d89-06cb-4a26-99d5-4f7e72aadd52",
      "unit": {}
    }
  }
}

If a field is omitted from the request body, then the existing value for that field will not change.

Notes for unit_group_id:

• This parameter is only available when Custom Unit Groups are enabled.
• It will assign the unit to the given unit group.
• A reference unit may only be moved if the request would empty its original group.
• A value of null will keep the unit in its current group.
• An empty string will remove the unit from its current unit group.

Array parameters (unit_amenities, tax_rates, or custom_field_values_attributes):

• If null is provided, the field's values will not be changed.
• If an empty array is provided, the field's values will be deleted.

Allowed values for door_type

• none
• roll_up
• swing

Allowed values for access_type

• indoor
• outdoor

Params

Examples

PUT /v1/434b7383-5576-48ee-bf86-a65cf3fdea3f/units/cbfed6ba-2742-4f68-a778-4436cdfd29f2
{
  "unit": {
    "name": "new unit name",
    "width": 8,
    "length": 9,
    "height": 10,
    "door_height": 8,
    "door_width": 9,
    "door_type": "swing",
    "access_type": "outdoor",
    "floor": 0,
    "walk_thru_order": 5,
    "standard_rate": 764.95,
    "rentable": false,
    "combination_lock_number": "12321",
    "overlock_lock_number": "54321",
    "attribute_description": "",
    "tax_rates": [
      "2bf62d80-fd2a-4646-950c-3022772c061a"
    ],
    "unit_amenities": [
      "edecec5c-7a96-425b-a8a5-286c893356e0"
    ],
    "unit_type": "49239ed3-63d2-4aa3-a225-3e4571ad27f7",
    "tier": "87bfa62a-b68c-4dd3-9b28-3bf4a435fc1b"
  }
}
200
{
  "unit": {
    "id": "cbfed6ba-2742-4f68-a778-4436cdfd29f2",
    "price": 764.95,
    "name": "new unit name",
    "description": "Amenity 3, 0th floor",
    "width": 8.0,
    "length": 9.0,
    "height": 10.0,
    "door_height": 8.0,
    "door_width": 9.0,
    "door_type": "swing",
    "access_type": "outdoor",
    "floor": 0,
    "directions": null,
    "size": "8x9x10",
    "area": 60.0,
    "standard_rate": 764.95,
    "managed_rate": null,
    "tiered_rate": null,
    "available_for_move_in": false,
    "rentable": false,
    "status": "vacant",
    "payment_status": null,
    "current_ledger_id": null,
    "current_tenant_id": null,
    "combo_lock_group": null,
    "combination_lock_number": "12321",
    "overlock_lock_number": null,
    "attribute_description": "",
    "deleted": false,
    "damaged": false,
    "complimentary": null,
    "unrentable": true,
    "company_owned": false,
    "is_prepped": null,
    "rank": null,
    "custom_fields": [],
    "allow_future_move_ins_limit": null,
    "channel_rate": null,
    "unit_amenities": [
      {
        "id": "edecec5c-7a96-425b-a8a5-286c893356e0",
        "name": "Amenity 3",
        "short_code": "A39",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 528
      }
    ],
    "unit_type": {
      "id": "49239ed3-63d2-4aa3-a225-3e4571ad27f7",
      "name": "Unit Type 194",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    "tier": {
      "id": "87bfa62a-b68c-4dd3-9b28-3bf4a435fc1b",
      "description": "Some description 1",
      "rank": 1,
      "deleted": false
    },
    "unit_group_id": "c9b5db0f-1f4e-4e85-8b1c-b3301c5709d3"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "PUT",
    "request_id": null,
    "parameters": {
      "unit": {
        "name": "new unit name",
        "width": 8,
        "length": 9,
        "height": 10,
        "door_height": 8,
        "door_width": 9,
        "door_type": "swing",
        "access_type": "outdoor",
        "floor": 0,
        "walk_thru_order": 5,
        "standard_rate": 764.95,
        "rentable": false,
        "combination_lock_number": "12321",
        "overlock_lock_number": "54321",
        "attribute_description": "",
        "tax_rates": [
          "2bf62d80-fd2a-4646-950c-3022772c061a"
        ],
        "unit_amenities": [
          "edecec5c-7a96-425b-a8a5-286c893356e0"
        ],
        "unit_type": "49239ed3-63d2-4aa3-a225-3e4571ad27f7",
        "tier": "87bfa62a-b68c-4dd3-9b28-3bf4a435fc1b"
      },
      "facility_id": "434b7383-5576-48ee-bf86-a65cf3fdea3f",
      "id": "cbfed6ba-2742-4f68-a778-4436cdfd29f2"
    }
  }
}

Updates one or more units that belong to the same facility. The units do not need to belong to the same unit group, and each unit can receive a different set of changes.

If a field is omitted from the request body, then the existing value for that field will not change.

Notes for unit_group_id:

• This parameter is only available when Custom Unit Groups are enabled.
• It will assign the unit to the given unit group.
• A reference unit may only be moved if the request would empty its original group.
• A value of null will keep the unit in its current group.
• An empty string will remove the unit from its current unit group.

Array parameters (unit_amenities, tax_rates, or custom_field_values_attributes):

• If null is provided, the field's values will not be changed.
• If an empty array is provided, the field's values will be deleted.

Allowed values for door_type

• none
• roll_up
• swing

Allowed values for access_type

• indoor
• outdoor

Possible errors:

• 400 Bad Request - Some of the parameters were invalid. The error_hash field in the response is structured as follows:
  • Each key in error_hash represents an error type (i.e. 'id', 'width', etc)
  • Each error type contains an array of objects representing the units with that error. These unit objects contain keys of 'id', 'name', and 'message'.
• 404 Not Found - Some of the unit ids were not found. The error_hash field in the response follows the structure described above.
• 500 Internal Server Error

Params

Examples

PUT /v1/bf850fa8-9dfb-4c92-bdbe-582c447b52d4/units/bulk_update
{
  "units": [
    {
      "id": "0561dc8c-f15f-46fb-9363-353d3bb4586d",
      "name": "updated unit name #1",
      "width": 9,
      "length": 10,
      "height": 11,
      "door_height": 7,
      "door_width": 8,
      "door_type": "swing",
      "access_type": "outdoor",
      "floor": 0,
      "walk_thru_order": 5,
      "standard_rate": 764.95,
      "rentable": true,
      "combination_lock_number": "14953",
      "overlock_lock_number": "72092",
      "attribute_description": "",
      "tax_rates": [
        "651566ec-5300-4f80-a883-eef2a9b1fe63"
      ],
      "unit_amenities": [
        "16167d4e-b59c-4167-abe7-e0073c049211"
      ],
      "unit_type": "de09aae9-6e93-4667-b48d-066d543e7a66"
    },
    {
      "id": "7442785e-0e41-40a8-a3d1-0641046f6014",
      "name": "updated unit name #2",
      "width": 12,
      "length": 13,
      "height": 14,
      "door_height": 9,
      "door_width": 10,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "walk_thru_order": 2,
      "standard_rate": 769.95,
      "rentable": true,
      "combination_lock_number": "24387",
      "overlock_lock_number": "33761",
      "attribute_description": "",
      "tax_rates": [
        "651566ec-5300-4f80-a883-eef2a9b1fe63"
      ],
      "unit_amenities": [
        "16167d4e-b59c-4167-abe7-e0073c049211"
      ],
      "unit_type": "de09aae9-6e93-4667-b48d-066d543e7a66"
    }
  ],
  "unit": {}
}
200
{
  "units": [
    {
      "id": "0561dc8c-f15f-46fb-9363-353d3bb4586d",
      "price": 764.95,
      "name": "updated unit name #1",
      "description": "0th floor",
      "width": 9.0,
      "length": 10.0,
      "height": 11.0,
      "door_height": 7.0,
      "door_width": 8.0,
      "door_type": "swing",
      "access_type": "outdoor",
      "floor": 0,
      "directions": null,
      "size": "9x10x11",
      "area": 60.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": "14953",
      "overlock_lock_number": null,
      "attribute_description": "",
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "de09aae9-6e93-4667-b48d-066d543e7a66",
        "name": "Unit Type 172",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "3560ecdb-c7f6-4bd8-aedf-5fea20acd509"
    },
    {
      "id": "7442785e-0e41-40a8-a3d1-0641046f6014",
      "price": 769.95,
      "name": "updated unit name #2",
      "description": "1st floor",
      "width": 12.0,
      "length": 13.0,
      "height": 14.0,
      "door_height": 9.0,
      "door_width": 10.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "directions": null,
      "size": "12x13x14",
      "area": 60.0,
      "standard_rate": 769.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": false,
      "rentable": true,
      "status": "occupied",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": "24387",
      "overlock_lock_number": null,
      "attribute_description": "",
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "de09aae9-6e93-4667-b48d-066d543e7a66",
        "name": "Unit Type 172",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "04f0b140-15d5-449f-be3c-3bbbc7a42f46"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 2,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "PUT",
    "request_id": null,
    "parameters": {
      "units": [
        {
          "id": "0561dc8c-f15f-46fb-9363-353d3bb4586d",
          "name": "updated unit name #1",
          "width": 9,
          "length": 10,
          "height": 11,
          "door_height": 7,
          "door_width": 8,
          "door_type": "swing",
          "access_type": "outdoor",
          "floor": 0,
          "walk_thru_order": 5,
          "standard_rate": 764.95,
          "rentable": true,
          "combination_lock_number": "14953",
          "overlock_lock_number": "72092",
          "attribute_description": "",
          "tax_rates": [
            "651566ec-5300-4f80-a883-eef2a9b1fe63"
          ],
          "unit_amenities": [
            "16167d4e-b59c-4167-abe7-e0073c049211"
          ],
          "unit_type": "de09aae9-6e93-4667-b48d-066d543e7a66"
        },
        {
          "id": "7442785e-0e41-40a8-a3d1-0641046f6014",
          "name": "updated unit name #2",
          "width": 12,
          "length": 13,
          "height": 14,
          "door_height": 9,
          "door_width": 10,
          "door_type": "roll_up",
          "access_type": "indoor",
          "floor": 1,
          "walk_thru_order": 2,
          "standard_rate": 769.95,
          "rentable": true,
          "combination_lock_number": "24387",
          "overlock_lock_number": "33761",
          "attribute_description": "",
          "tax_rates": [
            "651566ec-5300-4f80-a883-eef2a9b1fe63"
          ],
          "unit_amenities": [
            "16167d4e-b59c-4167-abe7-e0073c049211"
          ],
          "unit_type": "de09aae9-6e93-4667-b48d-066d543e7a66"
        }
      ],
      "facility_id": "bf850fa8-9dfb-4c92-bdbe-582c447b52d4",
      "unit": {}
    }
  }
}

Discussion

This endpoint can create multiple identical units at once by providing a comma-separated list of names for the name parameter.
The unit_group_id field is only available when Custom Unit Groups are enabled. It will assign the unit to the given unit group. Not providing a value or providing a value of null for unit_group_id means the unit will not be assigned to a group.

Params

Discussion

Creates one or more units for the same facility. Each unit can receive a different set of parameters and may end up in different unit groups.

Notes for unit_group_id:

• This parameter is only available when Custom Unit Groups are enabled.
• It will assign the unit to the given unit group.
• A value of null will result in the unit being ungrouped.

Allowed values for door_type

• none
• roll_up
• swing

Allowed values for access_type

• indoor
• outdoor

Possible errors:

• 400 Bad Request - Some of the parameters were invalid. The error_hash field in the response is structured as follows:
  • Each key in error_hash represents an error type (i.e. 'name', 'width', etc)
  • Each error type contains an array of objects representing the units with that error. These unit objects contain keys of 'name' and 'message'.
• 500 Internal Server Error

Params

Examples

POST /v1/2229756b-8faa-48bb-b235-42616185470f/units/bulk_create
{
  "units": [
    {
      "name": "new unit name #1",
      "width": 20.0,
      "length": 12.0,
      "height": 8.0,
      "door_height": 7,
      "door_width": 8,
      "door_type": "swing",
      "access_type": "outdoor",
      "floor": null,
      "walk_thru_order": 2,
      "standard_rate": 764.95,
      "rentable": true,
      "combination_lock_number": "34196",
      "overlock_lock_number": "57201",
      "attribute_description": "",
      "tax_rates": [
        "b8e13a42-3804-4ede-a763-3b83b3901536"
      ],
      "unit_amenities": [
        "43e22515-3b7f-48cc-b1ab-f177caec39a4"
      ],
      "unit_type": "f7687db9-654a-4018-8d27-bd0f3bfd25a0"
    },
    {
      "name": "new unit name #2",
      "width": 21.0,
      "length": 13.0,
      "height": 9.0,
      "door_height": 9,
      "door_width": 10,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "walk_thru_order": 1,
      "standard_rate": 765.95,
      "rentable": true,
      "combination_lock_number": "32109",
      "overlock_lock_number": "47682",
      "attribute_description": "",
      "tax_rates": [
        "b8e13a42-3804-4ede-a763-3b83b3901536"
      ],
      "unit_amenities": [
        "43e22515-3b7f-48cc-b1ab-f177caec39a4"
      ],
      "unit_type": "f7687db9-654a-4018-8d27-bd0f3bfd25a0"
    }
  ],
  "unit": {}
}
201
{
  "units": [
    {
      "id": "58734d21-9850-4f2d-8cf7-0de60caa31ca",
      "price": 764.95,
      "name": "new unit name #1",
      "description": "Amenity 4",
      "width": 20.0,
      "length": 12.0,
      "height": 8.0,
      "door_height": 7.0,
      "door_width": 8.0,
      "door_type": "swing",
      "access_type": "outdoor",
      "floor": null,
      "directions": null,
      "size": "20x12x8",
      "area": 240.0,
      "standard_rate": 764.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": "34196",
      "overlock_lock_number": null,
      "attribute_description": "",
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "43e22515-3b7f-48cc-b1ab-f177caec39a4",
          "name": "Amenity 4",
          "short_code": "A40",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 529
        }
      ],
      "unit_type": {
        "id": "f7687db9-654a-4018-8d27-bd0f3bfd25a0",
        "name": "Unit Type 216",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "4f7b35e8-c82b-40b0-9150-aa0b480c558e"
    },
    {
      "id": "6fe4ee64-e5cb-447e-b257-0912b01c5baa",
      "price": 765.95,
      "name": "new unit name #2",
      "description": "Amenity 4, 1st floor",
      "width": 21.0,
      "length": 13.0,
      "height": 9.0,
      "door_height": 9.0,
      "door_width": 10.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "directions": null,
      "size": "21x13x9",
      "area": 273.0,
      "standard_rate": 765.95,
      "managed_rate": null,
      "tiered_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": "32109",
      "overlock_lock_number": null,
      "attribute_description": "",
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "rank": null,
      "custom_fields": [],
      "allow_future_move_ins_limit": null,
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "43e22515-3b7f-48cc-b1ab-f177caec39a4",
          "name": "Amenity 4",
          "short_code": "A40",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 529
        }
      ],
      "unit_type": {
        "id": "f7687db9-654a-4018-8d27-bd0f3bfd25a0",
        "name": "Unit Type 216",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "tier": null,
      "unit_group_id": "0a4d80b1-1b29-4ff0-9b97-e71162121e92"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 2,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 201,
    "status_message": "Created",
    "status_cat": "https://http.cat/201",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "units": [
        {
          "name": "new unit name #1",
          "width": 20.0,
          "length": 12.0,
          "height": 8.0,
          "door_height": 7,
          "door_width": 8,
          "door_type": "swing",
          "access_type": "outdoor",
          "floor": null,
          "walk_thru_order": 2,
          "standard_rate": 764.95,
          "rentable": true,
          "combination_lock_number": "34196",
          "overlock_lock_number": "57201",
          "attribute_description": "",
          "tax_rates": [
            "b8e13a42-3804-4ede-a763-3b83b3901536"
          ],
          "unit_amenities": [
            "43e22515-3b7f-48cc-b1ab-f177caec39a4"
          ],
          "unit_type": "f7687db9-654a-4018-8d27-bd0f3bfd25a0"
        },
        {
          "name": "new unit name #2",
          "width": 21.0,
          "length": 13.0,
          "height": 9.0,
          "door_height": 9,
          "door_width": 10,
          "door_type": "roll_up",
          "access_type": "indoor",
          "floor": 1,
          "walk_thru_order": 1,
          "standard_rate": 765.95,
          "rentable": true,
          "combination_lock_number": "32109",
          "overlock_lock_number": "47682",
          "attribute_description": "",
          "tax_rates": [
            "b8e13a42-3804-4ede-a763-3b83b3901536"
          ],
          "unit_amenities": [
            "43e22515-3b7f-48cc-b1ab-f177caec39a4"
          ],
          "unit_type": "f7687db9-654a-4018-8d27-bd0f3bfd25a0"
        }
      ],
      "facility_id": "2229756b-8faa-48bb-b235-42616185470f",
      "unit": {}
    }
  }
}

Discussion

Given only a facility id, the default behavior of this endpoint will return relevent rate history details (for ALL units) with an effective_datetime falling on or between the beginning-of-day and end-of-day on which the request was made.
Optional: A unit_id may be supplied with the request, limiting the response results to rate history details associated with the given unit.
Optional: A start_date and end_date may be supplied with the request, which can provide rate history details over a span of time vs. the default behavior which is a 1 day timespan. The start_date and end_date may be no more than 31 days from one another.

Params