Get facilities by UUIDs

POST

api

{portfolio}

portfolios

facilities

get_by_uuids

[
  {
    "facilityUuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Downtown Storage Facility",
    "address1": "123 Main St",
    "address2": "Suite 200",
    "city": "Austin",
    "state": "TX",
    "zipcode": "78701",
    "latitude": "30.2672",
    "longitude": "-97.7431",
    "timeZone": "America/Chicago",
    "email": "[email protected]",
    "invoiceLeadDays": 14,
    "invoiceBillingSchedule": "ANNIVERSARY",
    "insuranceContactEmail": "[email protected]",
    "insuranceContactPhoneNumber": "5551234567",
    "operatingHours": {
      "Mon": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Tues": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Wed": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Thurs": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Fri": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Sat": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Sun": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      }
    },
    "contactEmail": "[email protected]",
    "contactPhone": "5551234567",
    "facilityGroups": [
      {
        "description": "West Coast Region",
        "facilityGroupUuid": "123e4567-e89b-12d3-a456-426614174000",
        "facilityGroupType": "Region"
      }
    ],
    "amenities": [
      {
        "amenityUuid": "123e4567-e89b-12d3-a456-426614174000",
        "description": "Climate Control"
      }
    ],
    "unitTypes": [
      {
        "unitTypeUuid": "123e4567-e89b-12d3-a456-426614174000",
        "description": "Self Storage"
      }
    ],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-02-01T00:00:00.000Z"
  }
]

Headers

x-api-key

any

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

Example:

"monument-2230012-2312321"

Path Parameters

Body

application/json

facilityUuids

string[]

required

Array of facility UUIDs to retrieve

Example:

["123e4567-e89b-12d3-a456-426614174000"]

Response

Facility details retrieved successfully

facilityUuid

string<uuid>

required

Facility UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

description

string

required

Facility description

Example:

"Downtown Storage Facility"

address1

string | null

required

Facility address line 1

Example:

"123 Main St"

address2

string | null

required

Facility address line 2

Example:

"Suite 200"

city

string | null

required

Facility city

Example:

"Austin"

state

string | null

required

Facility state

Example:

"TX"

zipcode

string | null

required

Facility zipcode

Example:

"78701"

latitude

string | null

required

Facility latitude

Example:

"30.2672"

longitude

string | null

required

Facility longitude

Example:

"-97.7431"

timeZone

string | null

required

Facility time zone

Example:

"America/Chicago"

string | null

required

Contact email for the facility

Example:

"[email protected]"

invoiceLeadDays

number

required

Invoice lead days

Example:

14

invoiceBillingSchedule

enum<string>

required

Invoice billing schedule

Available options:

ANNIVERSARY,

FIRST_OF_MONTH

Example:

"ANNIVERSARY"

insuranceContactEmail

string | null

required

Insurance contact email

Example:

"[email protected]"

insuranceContactPhoneNumber

string | null

required

Insurance contact phone number

Example:

"5551234567"

operatingHours

object

required

Operating hours for the facility

Show child attributes

operatingHours.Sun

object

required

Show child attributes

operatingHours.Sun.isOpen

boolean

required

operatingHours.Sun.openTime

string

operatingHours.Sun.closeTime

string

operatingHours.Mon

object

required

Show child attributes

operatingHours.Mon.isOpen

boolean

required

operatingHours.Mon.openTime

string

operatingHours.Mon.closeTime

string

operatingHours.Tues

object

required

Show child attributes

operatingHours.Tues.isOpen

boolean

required

operatingHours.Tues.openTime

string

operatingHours.Tues.closeTime

string

operatingHours.Wed

object

required

Show child attributes

operatingHours.Wed.isOpen

boolean

required

operatingHours.Wed.openTime

string

operatingHours.Wed.closeTime

string

operatingHours.Thurs

object

required

Show child attributes

operatingHours.Thurs.isOpen

boolean

required

operatingHours.Thurs.openTime

string

operatingHours.Thurs.closeTime

string

operatingHours.Fri

object

required

Show child attributes

operatingHours.Fri.isOpen

boolean

required

operatingHours.Fri.openTime

string

operatingHours.Fri.closeTime

string

operatingHours.Sat

object

required

Show child attributes

operatingHours.Sat.isOpen

boolean

required

operatingHours.Sat.openTime

string

operatingHours.Sat.closeTime

string

Example:

{
  "Mon": {
    "isOpen": true,
    "openTime": "10:00 AM",
    "closeTime": "9:00 PM"
  },
  "Tues": {
    "isOpen": true,
    "openTime": "10:00 AM",
    "closeTime": "9:00 PM"
  },
  "Wed": {
    "isOpen": true,
    "openTime": "10:00 AM",
    "closeTime": "9:00 PM"
  },
  "Thurs": {
    "isOpen": true,
    "openTime": "10:00 AM",
    "closeTime": "9:00 PM"
  },
  "Fri": {
    "isOpen": true,
    "openTime": "10:00 AM",
    "closeTime": "9:00 PM"
  },
  "Sat": {
    "isOpen": true,
    "openTime": "10:00 AM",
    "closeTime": "9:00 PM"
  },
  "Sun": {
    "isOpen": true,
    "openTime": "10:00 AM",
    "closeTime": "9:00 PM"
  }
}

contactEmail

string | null

required

Contact email for the facility

Example:

"[email protected]"

contactPhone

string | null

required

Contact phone number for the facility

Example:

"5551234567"

facilityGroups

object[]

required

List of facility groups the facility belongs to

Show child attributes

facilityGroups.facilityGroupUuid

string<uuid>

required

Facility group UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

facilityGroups.description

string

required

Facility group description

Example:

"West Coast Region"

facilityGroups.facilityGroupType

enum<string>

required

Facility group type

Available options:

Region,

Market,

Strategy,

Other

Example:

"Region"

Example:

[
  {
    "description": "West Coast Region",
    "facilityGroupUuid": "123e4567-e89b-12d3-a456-426614174000",
    "facilityGroupType": "Region"
  }
]

amenities

object[]

required

List of amenities available at the facility

Show child attributes

amenities.amenityUuid

string<uuid>

required

Amenity UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

amenities.description

string

required

Amenity description

Example:

"Climate Control"

Example:

[
  {
    "amenityUuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Climate Control"
  }
]

unitTypes

object[]

required

List of unit types available at the facility

Show child attributes

unitTypes.unitTypeUuid

string<uuid>

required

Unit type UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

unitTypes.description

string

required

Unit type description

Example:

"Self Storage"

Example:

[
  {
    "unitTypeUuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Self Storage"
  }
]

createdAt

string<date-time>

required

Created date

Example:

"2023-01-01T00:00:00.000Z"

updatedAt

string<date-time>

required

Updated date

Example:

"2023-02-01T00:00:00.000Z"

Update facility coverage optionsUpdates coverage options available for a facility, including default selection and enrollment availability

⌘I

[
  {
    "facilityUuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Downtown Storage Facility",
    "address1": "123 Main St",
    "address2": "Suite 200",
    "city": "Austin",
    "state": "TX",
    "zipcode": "78701",
    "latitude": "30.2672",
    "longitude": "-97.7431",
    "timeZone": "America/Chicago",
    "email": "[email protected]",
    "invoiceLeadDays": 14,
    "invoiceBillingSchedule": "ANNIVERSARY",
    "insuranceContactEmail": "[email protected]",
    "insuranceContactPhoneNumber": "5551234567",
    "operatingHours": {
      "Mon": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Tues": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Wed": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Thurs": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Fri": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Sat": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      },
      "Sun": {
        "isOpen": true,
        "openTime": "10:00 AM",
        "closeTime": "9:00 PM"
      }
    },
    "contactEmail": "[email protected]",
    "contactPhone": "5551234567",
    "facilityGroups": [
      {
        "description": "West Coast Region",
        "facilityGroupUuid": "123e4567-e89b-12d3-a456-426614174000",
        "facilityGroupType": "Region"
      }
    ],
    "amenities": [
      {
        "amenityUuid": "123e4567-e89b-12d3-a456-426614174000",
        "description": "Climate Control"
      }
    ],
    "unitTypes": [
      {
        "unitTypeUuid": "123e4567-e89b-12d3-a456-426614174000",
        "description": "Self Storage"
      }
    ],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-02-01T00:00:00.000Z"
  }
]

IntegrationAPI

API Reference

Headers

Path Parameters

Body

Response