Skip to main content
GET
/
shopping
/
{portfolio}
/
v1
/
shopping-cart
/
access-plans
/
{facilityUuid}
Retrieve access plans for a facility
curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/access-plans/{facilityUuid} \
  --header 'x-api-key: <x-api-key>'
[
  {
    "accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "itemType": {
      "itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "itemTypeName": "<string>",
      "description": "<string>",
      "category": "<string>",
      "isRecurring": true,
      "isRequiredAtMoveIn": true,
      "isRequiredAtTransfer": true,
      "isReadOnly": true,
      "isTaxable": true,
      "taxCode": "<string>",
      "isActive": true,
      "isProratedAtMoveIn": true,
      "feeType": "<string>",
      "fixedFeeAmount": 123,
      "feePercentage": 123
    },
    "accessPlanDayRules": [
      {
        "isOpen": false,
        "dayOfWeek": "Mon",
        "accessStartTime": "<string>",
        "accessEndTime": "<string>",
        "accessPlanDayRuleUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "name": "<string>",
    "isDefault": true,
    "isLegacy": true,
    "vendorName": "<string>",
    "facilities": [
      {
        "facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "facilityName": "<string>"
      }
    ],
    "planNameDescription": "<string>",
    "isManagedByVendor": true
  }
]

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid
string
required

Response

200 - application/json

The access plans for the specified facility with all related items

accessPlanUuid
string<uuid>
required
itemType
object
required
accessPlanDayRules
object[]
required
name
string
required
isDefault
boolean
required
isLegacy
boolean
required
vendorName
string
facilities
object[]
planNameDescription
string
isManagedByVendor
boolean