Skip to main content
POST
Get notes by UUIDs

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:

Response

Note details retrieved successfully

noteUuid
string<uuid>
required

UUID of the note

Example:

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

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."

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"