Get lead UUIDs for a facility

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

Query Parameters

updatedAt.lessOrEqual

string

Filter leads with updatedAt less than or equal to this date-time

updatedAt.greaterOrEqual

string

Filter leads with updatedAt greater than or equal to this date-time

createdAt.lessOrEqual

string

Filter leads with createdAt less than or equal to this date-time

createdAt.greaterOrEqual

string

Filter leads with createdAt greater than or equal to this date-time

leadStatus

enum<string>

Filter leads by status. Valid values: OPEN, CONVERTED, LOST, PENDING, RESERVED, WAITLISTED

Available options:

OPEN,

CONVERTED,

LOST,

PENDING,

RESERVED,

WAITLISTED

limit

number

globalFilterFacilityIds

string[]

filters

object

Show child attributes

filters[facilityUuid]

string<uuid>

required

Facility UUID to filter leads by

Example:

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

filters[updatedAtLessOrEqual]

string<date-time>

Filter by updatedAt less than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[updatedAtGreaterOrEqual]

string<date-time>

Filter by updatedAt greater than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[createdAtLessOrEqual]

string<date-time>

Filter by createdAt less than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[createdAtGreaterOrEqual]

string<date-time>

Filter by createdAt greater than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[leadStatus]

enum<string>

Filter leads by status. Valid values: OPEN, CONVERTED, LOST, PENDING, RESERVED, WAITLISTED

Available options:

OPEN,

CONVERTED,

LOST,

PENDING,

RESERVED,

WAITLISTED

Example:

"OPEN"

Response

200 - application/json

IntegrationAPI

API Reference

Headers

Path Parameters

Query Parameters

Response