Get lead details by UUIDs

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

leads

get_by_uuids

[
  {
    "leadUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "leadStatus": "OPEN",
    "dateCreated": "2024-01-01T00:00:00.000Z",
    "dateUpdated": "2024-01-01T00:00:00.000Z",
    "businessName": "ABC Company",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "primaryPerson": {
      "firstName": "John",
      "lastName": "Doe",
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001"
    },
    "leadSource": "Website",
    "dateDesiredMoveIn": "2024-01-15"
  }
]

Headers

x-api-key

any

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid

string

required

Body

application/json

leadUuids

string<uuid>[]

required

Array of lead UUIDs to retrieve details for

Example:

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

Response

Lead details retrieved

leadUuid

string<uuid>

required

Lead UUID

Example:

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

leadStatus

enum<string>

required

Lead status

Available options:

OPEN,

CONVERTED,

LOST,

PENDING,

RESERVED,

WAITLISTED

Example:

"OPEN"

dateCreated

string<date-time>

required

Date when the lead was created

Example:

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

dateUpdated

string<date-time>

required

Date when the lead was last updated

Example:

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

businessName

string | null

Business name (if applicable)

Example:

"ABC Company"

accountUuid

string<uuid> | null

Account UUID (if applicable)

Example:

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

primaryPerson

object

Primary person information

Show child attributes

primaryPerson.firstName

string | null

First name of the primary person

Example:

"John"

primaryPerson.lastName

string | null

Last name of the primary person

Example:

"Doe"

primaryPerson.addressLine1

string | null

Address line 1 of the primary person

Example:

"123 Main St"

primaryPerson.addressLine2

string | null

Address line 2 of the primary person

Example:

"Apt 4B"

primaryPerson.city

string | null

City of the primary person

Example:

"New York"

primaryPerson.state

string | null

State of the primary person

Example:

"NY"

primaryPerson.zip

string | null

ZIP code of the primary person

Example:

"10001"

leadSource

string | null

Lead source description

Example:

"Website"

dateDesiredMoveIn

string | null

Desired move-in date

Example:

"2024-01-15"

Get person UUIDsRetrieves the personUuids of all persons based on the applied filters

⌘I

[
  {
    "leadUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "leadStatus": "OPEN",
    "dateCreated": "2024-01-01T00:00:00.000Z",
    "dateUpdated": "2024-01-01T00:00:00.000Z",
    "businessName": "ABC Company",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "primaryPerson": {
      "firstName": "John",
      "lastName": "Doe",
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001"
    },
    "leadSource": "Website",
    "dateDesiredMoveIn": "2024-01-15"
  }
]

IntegrationAPI

API Reference

Headers

Path Parameters

Body

Response