Get lead details by UUIDs

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

leads

get_by_uuids

Get lead details by UUIDs

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

import requests

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

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

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/leads/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/facilities/{facilityUuid}/leads/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([
    'leadUuids' => [
        '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/facilities/{facilityUuid}/leads/get_by_uuids"

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

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

[
  {
    "leadUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "unitGroupUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "leadStatus": "OPEN",
    "accountStatus": "ACTIVE",
    "dateCreated": "2024-01-01T00:00:00.000Z",
    "dateUpdated": "2024-01-01T00:00:00.000Z",
    "businessName": "ABC Company",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "primaryPerson": {
      "optedIntoSms": true,
      "firstName": "John",
      "lastName": "Doe",
      "phone": "1234567890",
      "email": "test@email.com",
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001"
    },
    "leadSource": "Website",
    "leadMarketingSourceUuid": "123e4567-e89b-12d3-a456-426614174009",
    "leadMarketingSource": "Google Ads",
    "dateDesiredMoveIn": "2024-01-15",
    "agentUserAccountUuid": "123e4567-e89b-12d3-a456-426614174010",
    "agentName": "Jane Doe"
  }
]

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

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"

unitGroupUuid

string<uuid> | null

required

Unit group UUID (if selected)

Example:

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

leadStatus

enum<string>

required

Lead status

Available options:

OPEN,

CONVERTED,

LOST,

PENDING,

RESERVED,

WAITLISTED

Example:

"OPEN"

accountStatus

enum<string> | null

required

Account status

Available options:

PENDING_ACTIVATION,

ACTIVE,

PENDING_DEACTIVATION,

DEACTIVATED,

MERGED

Example:

"ACTIVE"

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 | null

Primary person information

Show child attributes

leadSource

string | null

Lead source description

Example:

"Website"

leadMarketingSourceUuid

string<uuid> | null

UUID of the marketing source. Stable across renames, unlike the description. This API has no marketing-source lookup today, so the uuid cannot be resolved to a name here — read the description field alongside it.

Example:

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

leadMarketingSource

string | null

How the customer heard about the property. Customer-maintained and renameable, and distinct from leadSource, which is the channel the lead entered through.

Example:

"Google Ads"

dateDesiredMoveIn

string | null

Desired move-in date

Example:

"2024-01-15"

agentUserAccountUuid

string<uuid> | null

Removed in next release

UUID of the staff user who created the lead. It identifies who created the lead, not who is working it now. Null when no staff user created the lead, such as leads submitted through the online rental flow or imported from another system.

Example:

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

agentName

string | null

Removed in next release

First and last name of the staff user who created the lead. Null whenever agentUserAccountUuid is null.

Example:

"Jane Doe"

Get lead details by UUIDs

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

import requests

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

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

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/leads/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/facilities/{facilityUuid}/leads/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([
    'leadUuids' => [
        '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/facilities/{facilityUuid}/leads/get_by_uuids"

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

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

[
  {
    "leadUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "unitGroupUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "leadStatus": "OPEN",
    "accountStatus": "ACTIVE",
    "dateCreated": "2024-01-01T00:00:00.000Z",
    "dateUpdated": "2024-01-01T00:00:00.000Z",
    "businessName": "ABC Company",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "primaryPerson": {
      "optedIntoSms": true,
      "firstName": "John",
      "lastName": "Doe",
      "phone": "1234567890",
      "email": "test@email.com",
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001"
    },
    "leadSource": "Website",
    "leadMarketingSourceUuid": "123e4567-e89b-12d3-a456-426614174009",
    "leadMarketingSource": "Google Ads",
    "dateDesiredMoveIn": "2024-01-15",
    "agentUserAccountUuid": "123e4567-e89b-12d3-a456-426614174010",
    "agentName": "Jane Doe"
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

GL Accounts

ECRI

Journal Entries

Ledger Entries

Rent Changes

Payments

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Webhooks

Headers

Path Parameters

Body

Response