Get Tenant (Account) UUIDs - Monument Public API

GET

/

api

/

{portfolio}

/

portfolios

/

v1

/

tenants

/

uuids

Get Tenant (Account) UUIDs

curl --request GET \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/uuids \
  --header 'x-api-key: <x-api-key>'

import requests

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

headers = {"x-api-key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/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/uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'

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

[
  "<string>"
]

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

Query Parameters

updatedAt.lessOrEqual

string

Filter tenants with updatedAt less than or equal to this date-time

updatedAt.greaterOrEqual

string

Filter tenants with updatedAt greater than or equal to this date-time

createdAt.lessOrEqual

string

Filter tenants with createdAt less than or equal to this date-time

createdAt.greaterOrEqual

string

Filter tenants with createdAt greater than or equal to this date-time

nextBillingDueDate.lessOrEqual

string

nextBillingDueDate.greaterOrEqual

string

phone

string

Filter tenants whose primary contact has this phone number. Accepts (NPA) NXX-XXXX, NPA-NXX-XXXX or NPANXXXXXX, optionally prefixed with the +1 country code, and matches the ten stored digits exactly. Returns an empty array when no tenant matches.

email

string

Filter tenants whose primary contact has this email address. Exact match, case-insensitive. Returns an empty array when no tenant matches.

Response

200 - application/json

Array of tenant (account) UUIDs, most recently updated first, empty if none are found.

Get Tenant (Account) UUIDs

curl --request GET \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/uuids \
  --header 'x-api-key: <x-api-key>'

import requests

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

headers = {"x-api-key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/tenants/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/uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'

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

[
  "<string>"
]