Get tenants by UUIDs - Monument Public API

POST

api

{portfolio}

portfolios

tenants

get_by_uuids

Get tenants by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "tenantUuids": [
    "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12"
  ]
}
'

import requests

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

payload = { "tenantUuids": ["a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12"] }
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({
    tenantUuids: ['a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11', 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/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/tenants/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([
    'tenantUuids' => [
        'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11',
        'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12'
    ]
  ]),
  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/tenants/get_by_uuids"

	payload := strings.NewReader("{\n  \"tenantUuids\": [\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12\"\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/tenants/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tenantUuids\": [\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/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  \"tenantUuids\": [\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12\"\n  ]\n}"

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

[
  {
    "tenantUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "rentalRecordUuids": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "3fa85f64-5717-4562-b3fc-2c963f66afa7"
    ],
    "accountType": "Personal",
    "noteUuids": [
      "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
      "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
    ],
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "primaryPersonUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "primaryContact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "optedIntoSms": true,
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "Anytown",
      "state": "CA",
      "zipcode": "90210",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "driverLicenseNumber": "1234567890",
      "driverLicenseState": "CA",
      "passportNumber": "1234567890",
      "passportCountry": "US",
      "documentExpirationDate": "2024-01-01",
      "dateOfBirth": "2024-01-01"
    },
    "active": true,
    "sourceLeadUuids": [
      "6fa85f64-5717-4562-b3fc-2c963f66afa6",
      "7fa85f64-5717-4562-b3fc-2c963f66afa7"
    ],
    "businessName": "Acme Storage LLC",
    "alternateContacts": [],
    "nextBillingDueDate": "2024-02-15T00:00:00.000Z",
    "owedBalance": 1250.5,
    "balanceAge": 15,
    "desiredMoveInDate": "2024-03-15T00: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

tenantUuids

string<uuid>[]

required

Array of tenant UUIDs to retrieve details for

Example:

[
  "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12"
]

Response

Tenant details retrieved successfully

tenantUuid

string<uuid>

required

Tenant UUID

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

rentalRecordUuids

string<uuid>[]

required

Array of associated rental record UUIDs

Example:

[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "3fa85f64-5717-4562-b3fc-2c963f66afa7"
]

accountType

enum<string>

required

Account type

Available options:

Business,

Personal

Example:

"Personal"

noteUuids

string<uuid>[]

required

Array of note UUIDs associated with the tenant

Example:

[
  "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
  "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
]

createdAt

string<date-time>

required

Timestamp when the tenant was created

Example:

"2024-01-15T10:30:00.000Z"

updatedAt

string<date-time>

required

Timestamp when the tenant was last updated

Example:

"2024-01-20T15:45:00.000Z"

primaryPersonUuid

string<uuid>

required

Primary person UUID associated with the tenant

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

primaryContact

object

required

Primary contact details for the tenant

Show child attributes

active

boolean

required

Whether the tenant has any active rental records (startRentDate <= now and (endRentDate >= now or endRentDate is null))

Example:

true

sourceLeadUuids

string<uuid>[]

required

Array of lead UUIDs associated with this account

Example:

[
  "6fa85f64-5717-4562-b3fc-2c963f66afa6",
  "7fa85f64-5717-4562-b3fc-2c963f66afa7"
]

businessName

string | null

Business name (populated for BUSINESS accounts, null for PERSONAL)

Example:

"Acme Storage LLC"

alternateContacts

object[]

Array of alternate contact details (if available)

Show child attributes

Example:

[]

nextBillingDueDate

string<date-time> | null

Earliest billing due date from billing templates for this tenant

Example:

"2024-02-15T00:00:00.000Z"

owedBalance

number | null

Sum of the positive balances for the unit rental records associated with this tenant, this does not include credits when tenant does not owe money. Returned in pennies.

Example:

1250.5

balanceAge

number | null

Days since today for the oldest created date of still open/overdue/partial invoices. 0 if no such invoices exist

Example:

15

desiredMoveInDate

string<date-time> | null

Desired move-in date from associated leads

Example:

"2024-03-15T00:00:00.000Z"

Update Person Email or PhoneUpdates the email or phone number for a person. Phone number must be in format (NPA) NXX-XXXX, NPA-NXX-XXXX, or NPANXXXXXX.

Get tenants by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "tenantUuids": [
    "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12"
  ]
}
'

import requests

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

payload = { "tenantUuids": ["a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12"] }
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({
    tenantUuids: ['a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11', 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/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/tenants/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([
    'tenantUuids' => [
        'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11',
        'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12'
    ]
  ]),
  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/tenants/get_by_uuids"

	payload := strings.NewReader("{\n  \"tenantUuids\": [\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12\"\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/tenants/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tenantUuids\": [\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/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  \"tenantUuids\": [\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n    \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12\"\n  ]\n}"

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

[
  {
    "tenantUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "rentalRecordUuids": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "3fa85f64-5717-4562-b3fc-2c963f66afa7"
    ],
    "accountType": "Personal",
    "noteUuids": [
      "4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e",
      "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
    ],
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "primaryPersonUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
    "primaryContact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "optedIntoSms": true,
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "Anytown",
      "state": "CA",
      "zipcode": "90210",
      "email": "jane.doe@example.com",
      "phone": "+15551234567",
      "driverLicenseNumber": "1234567890",
      "driverLicenseState": "CA",
      "passportNumber": "1234567890",
      "passportCountry": "US",
      "documentExpirationDate": "2024-01-01",
      "dateOfBirth": "2024-01-01"
    },
    "active": true,
    "sourceLeadUuids": [
      "6fa85f64-5717-4562-b3fc-2c963f66afa6",
      "7fa85f64-5717-4562-b3fc-2c963f66afa7"
    ],
    "businessName": "Acme Storage LLC",
    "alternateContacts": [],
    "nextBillingDueDate": "2024-02-15T00:00:00.000Z",
    "owedBalance": 1250.5,
    "balanceAge": 15,
    "desiredMoveInDate": "2024-03-15T00:00:00.000Z"
  }
]