Get facilities by UUIDs

POST

api

{portfolio}

portfolios

facilities

get_by_uuids

Get facilities by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "facilityUuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids"

payload = { "facilityUuids": ["123e4567-e89b-12d3-a456-426614174000"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({facilityUuids: ['123e4567-e89b-12d3-a456-426614174000']})
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'facilityUuids' => [
        '123e4567-e89b-12d3-a456-426614174000'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids"

	payload := strings.NewReader("{\n  \"facilityUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"facilityUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"facilityUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "facilityUuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Downtown Storage Facility",
    "address1": "123 Main St",
    "address2": "Suite 200",
    "city": "Austin",
    "state": "TX",
    "zipcode": "78701",
    "country": "USA",
    "latitude": "30.2672",
    "longitude": "-97.7431",
    "timeZone": "America/Chicago",
    "email": "contact@example.com",
    "invoiceLeadDays": 14,
    "invoiceBillingSchedule": "ANNIVERSARY",
    "insuranceContactEmail": "contact@example.com",
    "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": "contact@example.com",
    "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

required

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"

country

string

required

Facility country

Example:

"USA"

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:

"contact@example.com"

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:

"contact@example.com"

insuranceContactPhoneNumber

string | null

required

Insurance contact phone number

Example:

"5551234567"

operatingHours

object

required

Operating hours for the facility

Show child attributes

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:

"contact@example.com"

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

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

Example:

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

unitTypes

object[]

required

List of unit types available at the facility

Show child attributes

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

Get facilities by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "facilityUuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids"

payload = { "facilityUuids": ["123e4567-e89b-12d3-a456-426614174000"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({facilityUuids: ['123e4567-e89b-12d3-a456-426614174000']})
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'facilityUuids' => [
        '123e4567-e89b-12d3-a456-426614174000'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids"

	payload := strings.NewReader("{\n  \"facilityUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"facilityUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"facilityUuids\": [\n    \"123e4567-e89b-12d3-a456-426614174000\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "facilityUuid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Downtown Storage Facility",
    "address1": "123 Main St",
    "address2": "Suite 200",
    "city": "Austin",
    "state": "TX",
    "zipcode": "78701",
    "country": "USA",
    "latitude": "30.2672",
    "longitude": "-97.7431",
    "timeZone": "America/Chicago",
    "email": "contact@example.com",
    "invoiceLeadDays": 14,
    "invoiceBillingSchedule": "ANNIVERSARY",
    "insuranceContactEmail": "contact@example.com",
    "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": "contact@example.com",
    "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"
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

ECRI

Ledger Entries

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Payments

Webhooks

Headers

Path Parameters

Body

Response