Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
people
/
get_by_uuids
Get person details by UUIDs
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/people/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "personUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'
[
  {
    "personUuid": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "5551234567",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "isPrimary": true,
    "tenantUuid": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "rentalRecordUuids": [
      "123e4567-e89b-12d3-a456-426614174000",
      "123e4567-e89b-12d3-a456-426614174001"
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://api.monument.io/llms.txt

Use this file to discover all available pages before exploring further.

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
​
personUuids
string<uuid>[]
required

Array of person UUIDs to retrieve details for

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

Response

Person details retrieved

​
personUuid
string
required

Person UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
firstName
string
required

First name

Example:

"John"

​
lastName
string
required

Last name

Example:

"Doe"

​
email
string | null
required

Email address

Example:

"john.doe@example.com"

​
phone
string | null
required

Phone number

Example:

"5551234567"

​
createdAt
string<date-time>
required

Creation date

Example:

"2024-01-01T00:00:00.000Z"

​
updatedAt
string<date-time>
required

Last update date

Example:

"2024-01-01T00:00:00.000Z"

​
isPrimary
boolean
required

True if this person is a primary person for an account

Example:

true

​
tenantUuid
string | null
required

Account UUID associated with the person, or null if there is no account

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
isActive
boolean
required

True if they have any active unit rental records

Example:

true

​
rentalRecordUuids
string[]
required

Array of unit rental record UUIDs associated with the person

Example:
[
  "123e4567-e89b-12d3-a456-426614174000",
  "123e4567-e89b-12d3-a456-426614174001"
]