Get notes by UUIDs

POST

api

{portfolio}

portfolios

notes

get_by_uuids

Get notes by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/notes/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "noteUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

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

payload = { "noteUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
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({
    noteUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/notes/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/notes/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([
    'noteUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  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/notes/get_by_uuids"

	payload := strings.NewReader("{\n  \"noteUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\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/notes/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"noteUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/notes/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  \"noteUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

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

[
  {
    "noteUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "PERSON",
    "unitUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "personUuid": null,
    "bodyText": "This is a note about a unit regarding maintenance issues.",
    "createdByUuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdByFirstName": "Jane",
    "createdByLastName": "Smith",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "isPinned": true,
    "pinnedAt": "2026-07-24T15:02:00.000Z",
    "facilityUuids": [
      "5c1f9f1e-8b0a-4c2e-9f3d-6a7b8c9d0e1f"
    ],
    "rentalRecordUuids": [
      "9d8c7b6a-5e4f-3a2b-1c0d-9e8f7a6b5c4d"
    ]
  }
]

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

noteUuids

string<uuid>[]

required

Array of note UUIDs to retrieve data for

Example:

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

Response

Note details retrieved successfully

noteUuid

string<uuid>

required

UUID of the note

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

entityType

enum<string>

required

Type of the entity the note is attached to

Available options:

UNIT,

PERSON,

PHYSICAL_LOCK_ASSIGNMENT,

CALL

Example:

"PERSON"

unitUuid

string<uuid> | null

required

UUID of the unit if note.entityType is UNIT, null otherwise

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

personUuid

string<uuid> | null

required

UUID of the person if note.entityType is PERSON, null otherwise

Example:

null

bodyText

string

required

The text content of the note

Example:

"This is a note about a unit regarding maintenance issues."

createdByUuid

string<uuid>

required

UUID of the user who created the note

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

createdByFirstName

string | null

required

First name of the user who created the note

Example:

"Jane"

createdByLastName

string | null

required

Last name of the user who created the note

Example:

"Smith"

createdAt

string<date-time>

required

Timestamp when the note was created

Example:

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

updatedAt

string<date-time>

required

Timestamp when the note was last updated

Example:

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

isPinned

boolean | null

required

Whether the note is pinned. Null on notes whose entityType is not PERSON, where pinning does not apply

Example:

true

pinnedAt

string<date-time> | null

required

Timestamp when the note was pinned, null when it is not pinned or pinning does not apply

Example:

"2026-07-24T15:02:00.000Z"

facilityUuids

string<uuid>[]

required

Facilities the note subject is attached to, through their open rentals or their lead records, empty when none apply

Example:

["5c1f9f1e-8b0a-4c2e-9f3d-6a7b8c9d0e1f"]

rentalRecordUuids

string<uuid>[]

required

Open unit rental records of the note subject, meaning pending move-in, moved in or pending move-out, empty when none apply

Example:

["9d8c7b6a-5e4f-3a2b-1c0d-9e8f7a6b5c4d"]

Get notes by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/notes/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "noteUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

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

payload = { "noteUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
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({
    noteUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/notes/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/notes/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([
    'noteUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  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/notes/get_by_uuids"

	payload := strings.NewReader("{\n  \"noteUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\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/notes/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"noteUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/notes/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  \"noteUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

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

[
  {
    "noteUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "PERSON",
    "unitUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "personUuid": null,
    "bodyText": "This is a note about a unit regarding maintenance issues.",
    "createdByUuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdByFirstName": "Jane",
    "createdByLastName": "Smith",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "isPinned": true,
    "pinnedAt": "2026-07-24T15:02:00.000Z",
    "facilityUuids": [
      "5c1f9f1e-8b0a-4c2e-9f3d-6a7b8c9d0e1f"
    ],
    "rentalRecordUuids": [
      "9d8c7b6a-5e4f-3a2b-1c0d-9e8f7a6b5c4d"
    ]
  }
]

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