Get rental flow configuration for a facility

GET

shopping

{portfolio}

facilities

{facilityUuid}

config

Get rental flow configuration for a facility

curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/facilities/{facilityUuid}/config \
  --header 'x-api-key: <x-api-key>'

{}

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

Response

Rental flow configuration retrieved successfully

The response is of type object.

Get required fields for a facilityReturns the required fields derived from the facility's rental flow configuration (org-specific, or the system default when the org has none). Each field carries its isSystemRequired flag: true means it blocks lease generation, false means it is org-required only.

Get rental flow configuration for a facility

curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/facilities/{facilityUuid}/config \
  --header 'x-api-key: <x-api-key>'

{}