API reference · Communities & institutions

Rentals listings

GET/rental/application/mineYour applications
POST/rental/application/{reference}/declineDecline an application
POST/rental/application/{reference}/offerOffer the tenancy
POST/rental/application/{reference}/signSign the offered tenancy
POST/rental/application/{reference}/withdrawWithdraw your application
POST/rental/listingList a unit
GET/rental/listing/mineYour listings
GET/rental/listing/{reference}A listing
GET/rental/listing/{reference}/applicationsApplications on your listing
POST/rental/listing/{reference}/applyApply for a listed unit
POST/rental/listing/{reference}/viewing-requestAsk to view a unit
GET/rental/listing/{reference}/viewingsViewing requests on your listing
POST/rental/listing/{reference}/withdrawWithdraw a listing
GET/rental/listingsSearch listings
POST/rental/viewing/{reference}/decisionConfirm or decline a viewing

GET Your applications

GET /rental/application/mine

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListApplicationResponse

curl -X GET "https://api.bridgemoni.com/rental/application/mine" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "applicantPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "status": "SUBMITTED",
      "message": "string",
      "proposedCommencement": "2026-09-25",
      "offeredCommencement": "2026-09-25",
      "offeredExpiry": "2026-09-25",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "sharedRecord": {
        "facts": {
          "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "partyType": "OCCUPANT",
          "erased": true,
          "asOf": "2026-09-25T10:00:00Z",
          "facts": [
            {
              "key": "rental.on_time_rate_24m",
              "value": 0,
              "unit": "RATIO",
              "observations": 0,
              "windowStart": "2026-09-25",
              "windowEnd": "2026-09-25"
            }
          ]
        },
        "reviews": [
          {
            "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
            "target": "PROPERTY",
            "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
            "rating": 0,
            "body": "string",
            "status": "PUBLISHED",
            "reply": "string",
            "repliedAt": "2026-09-25T10:00:00Z",
            "creationDateTime": "2026-09-25T10:00:00Z"
          }
        ]
      },
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Applications retrieved successfully"
}

Responses

Status	When
`200`	Applications retrieved successfully

POST Decline an application

POST /rental/application/{reference}/decline

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseApplicationResponse

curl -X POST "https://api.bridgemoni.com/rental/application/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/decline" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "applicantPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "SUBMITTED",
    "message": "string",
    "proposedCommencement": "2026-09-25",
    "offeredCommencement": "2026-09-25",
    "offeredExpiry": "2026-09-25",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sharedRecord": {
      "facts": {
        "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "partyType": "OCCUPANT",
        "erased": true,
        "asOf": "2026-09-25T10:00:00Z",
        "facts": [
          {
            "key": "rental.on_time_rate_24m",
            "value": 0,
            "unit": "RATIO",
            "observations": 0,
            "windowStart": "2026-09-25",
            "windowEnd": "2026-09-25"
          }
        ]
      },
      "reviews": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "target": "PROPERTY",
          "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "rating": 0,
          "body": "string",
          "status": "PUBLISHED",
          "reply": "string",
          "repliedAt": "2026-09-25T10:00:00Z",
          "creationDateTime": "2026-09-25T10:00:00Z"
        }
      ]
    },
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Application declined successfully"
}

Responses

Status	When
`200`	Application declined successfully

POST Offer the tenancy

POST /rental/application/{reference}/offer

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: OfferRequest · Response: GenericResponseApplicationResponse

curl -X POST "https://api.bridgemoni.com/rental/application/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/offer" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "commencementDate": "2026-09-25",
  "expiryDate": "2026-09-25"
}'

{
  "commencementDate": "2026-09-25",
  "expiryDate": "2026-09-25"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "applicantPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "SUBMITTED",
    "message": "string",
    "proposedCommencement": "2026-09-25",
    "offeredCommencement": "2026-09-25",
    "offeredExpiry": "2026-09-25",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sharedRecord": {
      "facts": {
        "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "partyType": "OCCUPANT",
        "erased": true,
        "asOf": "2026-09-25T10:00:00Z",
        "facts": [
          {
            "key": "rental.on_time_rate_24m",
            "value": 0,
            "unit": "RATIO",
            "observations": 0,
            "windowStart": "2026-09-25",
            "windowEnd": "2026-09-25"
          }
        ]
      },
      "reviews": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "target": "PROPERTY",
          "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "rating": 0,
          "body": "string",
          "status": "PUBLISHED",
          "reply": "string",
          "repliedAt": "2026-09-25T10:00:00Z",
          "creationDateTime": "2026-09-25T10:00:00Z"
        }
      ]
    },
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Offer made successfully"
}

Responses

Status	When
`200`	Offer made successfully

POST Sign the offered tenancy

POST /rental/application/{reference}/sign

Registers the tenancy on the listed terms with the listing's landlord and agent. The landlord countersigns with the tenancy confirmation, and neither party leaves the platform.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseApplicationResponse

curl -X POST "https://api.bridgemoni.com/rental/application/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/sign" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "applicantPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "SUBMITTED",
    "message": "string",
    "proposedCommencement": "2026-09-25",
    "offeredCommencement": "2026-09-25",
    "offeredExpiry": "2026-09-25",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sharedRecord": {
      "facts": {
        "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "partyType": "OCCUPANT",
        "erased": true,
        "asOf": "2026-09-25T10:00:00Z",
        "facts": [
          {
            "key": "rental.on_time_rate_24m",
            "value": 0,
            "unit": "RATIO",
            "observations": 0,
            "windowStart": "2026-09-25",
            "windowEnd": "2026-09-25"
          }
        ]
      },
      "reviews": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "target": "PROPERTY",
          "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "rating": 0,
          "body": "string",
          "status": "PUBLISHED",
          "reply": "string",
          "repliedAt": "2026-09-25T10:00:00Z",
          "creationDateTime": "2026-09-25T10:00:00Z"
        }
      ]
    },
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Agreement signed successfully"
}

Responses

Status	When
`200`	Agreement signed successfully

POST Withdraw your application

POST /rental/application/{reference}/withdraw

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseApplicationResponse

curl -X POST "https://api.bridgemoni.com/rental/application/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/withdraw" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "applicantPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "SUBMITTED",
    "message": "string",
    "proposedCommencement": "2026-09-25",
    "offeredCommencement": "2026-09-25",
    "offeredExpiry": "2026-09-25",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sharedRecord": {
      "facts": {
        "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "partyType": "OCCUPANT",
        "erased": true,
        "asOf": "2026-09-25T10:00:00Z",
        "facts": [
          {
            "key": "rental.on_time_rate_24m",
            "value": 0,
            "unit": "RATIO",
            "observations": 0,
            "windowStart": "2026-09-25",
            "windowEnd": "2026-09-25"
          }
        ]
      },
      "reviews": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "target": "PROPERTY",
          "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "rating": 0,
          "body": "string",
          "status": "PUBLISHED",
          "reply": "string",
          "repliedAt": "2026-09-25T10:00:00Z",
          "creationDateTime": "2026-09-25T10:00:00Z"
        }
      ]
    },
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Application withdrawn successfully"
}

Responses

Status	When
`200`	Application withdrawn successfully

POST List a unit

POST /rental/listing

By the property's verified owner, or by the agent holding the unit's listing claim. A property whose ownership nobody verified cannot be listed.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Example

Request body: ListingRequest · Response: GenericResponseListingResponse

curl -X POST "https://api.bridgemoni.com/rental/listing" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "askingRent": 2400000.0,
  "rentCadence": "MONTHLY",
  "depositAmount": 0,
  "availableFrom": "2026-09-25",
  "description": "Two-bedroom flat, prepaid meter, borehole water"
}'

{
  "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "askingRent": 2400000.0,
  "rentCadence": "MONTHLY",
  "depositAmount": 0,
  "availableFrom": "2026-09-25",
  "description": "Two-bedroom flat, prepaid meter, borehole water"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "marketCode": "string",
    "area": "string",
    "city": "string",
    "propertyType": "string",
    "unitType": "string",
    "bedrooms": 0,
    "askingRent": 0,
    "currencyCode": "string",
    "rentCadence": "MONTHLY",
    "depositAmount": 0,
    "availableFrom": "2026-09-25",
    "description": "string",
    "listedBy": "OCCUPANT",
    "ownershipVerified": true,
    "status": "PUBLISHED",
    "publishedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Listing published successfully"
}

Responses

Status	When
`200`	Listing published successfully
`409`	Not the verified owner or the claiming agent, or already listed

GET Your listings

GET /rental/listing/mine

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListListingResponse

curl -X GET "https://api.bridgemoni.com/rental/listing/mine" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "marketCode": "string",
      "area": "string",
      "city": "string",
      "propertyType": "string",
      "unitType": "string",
      "bedrooms": 0,
      "askingRent": 0,
      "currencyCode": "string",
      "rentCadence": "MONTHLY",
      "depositAmount": 0,
      "availableFrom": "2026-09-25",
      "description": "string",
      "listedBy": "OCCUPANT",
      "ownershipVerified": true,
      "status": "PUBLISHED",
      "publishedAt": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Listings retrieved successfully"
}

Responses

Status	When
`200`	Listings retrieved successfully

GET A listing

GET /rental/listing/{reference}

Open to anyone, without an account.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`X-Forwarded-For`

Path parameters

Name
`reference`

Example

Response: GenericResponseListingResponse

curl -X GET "https://api.bridgemoni.com/rental/listing/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "marketCode": "string",
    "area": "string",
    "city": "string",
    "propertyType": "string",
    "unitType": "string",
    "bedrooms": 0,
    "askingRent": 0,
    "currencyCode": "string",
    "rentCadence": "MONTHLY",
    "depositAmount": 0,
    "availableFrom": "2026-09-25",
    "description": "string",
    "listedBy": "OCCUPANT",
    "ownershipVerified": true,
    "status": "PUBLISHED",
    "publishedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Listing retrieved successfully"
}

Responses

Status	When
`200`	Listing retrieved successfully
`404`	Not available
`429`	Too many requests from this address

GET Applications on your listing

GET /rental/listing/{reference}/applications

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListApplicationResponse

curl -X GET "https://api.bridgemoni.com/rental/listing/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/applications" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "applicantPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "status": "SUBMITTED",
      "message": "string",
      "proposedCommencement": "2026-09-25",
      "offeredCommencement": "2026-09-25",
      "offeredExpiry": "2026-09-25",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "sharedRecord": {
        "facts": {
          "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "partyType": "OCCUPANT",
          "erased": true,
          "asOf": "2026-09-25T10:00:00Z",
          "facts": [
            {
              "key": "rental.on_time_rate_24m",
              "value": 0,
              "unit": "RATIO",
              "observations": 0,
              "windowStart": "2026-09-25",
              "windowEnd": "2026-09-25"
            }
          ]
        },
        "reviews": [
          {
            "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
            "target": "PROPERTY",
            "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
            "rating": 0,
            "body": "string",
            "status": "PUBLISHED",
            "reply": "string",
            "repliedAt": "2026-09-25T10:00:00Z",
            "creationDateTime": "2026-09-25T10:00:00Z"
          }
        ]
      },
      "creationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Applications retrieved successfully"
}

Responses

Status	When
`200`	Applications retrieved successfully

POST Apply for a listed unit

POST /rental/listing/{reference}/apply

Attach a share link to show the lister your record while the application is live; nothing about you is disclosed without one.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: ApplicationRequest · Response: GenericResponseApplicationResponse

curl -X POST "https://api.bridgemoni.com/rental/listing/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/apply" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "string",
  "shareToken": "string",
  "proposedCommencement": "2026-09-25"
}'

{
  "message": "string",
  "shareToken": "string",
  "proposedCommencement": "2026-09-25"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "applicantPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "SUBMITTED",
    "message": "string",
    "proposedCommencement": "2026-09-25",
    "offeredCommencement": "2026-09-25",
    "offeredExpiry": "2026-09-25",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sharedRecord": {
      "facts": {
        "partyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "partyType": "OCCUPANT",
        "erased": true,
        "asOf": "2026-09-25T10:00:00Z",
        "facts": [
          {
            "key": "rental.on_time_rate_24m",
            "value": 0,
            "unit": "RATIO",
            "observations": 0,
            "windowStart": "2026-09-25",
            "windowEnd": "2026-09-25"
          }
        ]
      },
      "reviews": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "target": "PROPERTY",
          "targetReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "rating": 0,
          "body": "string",
          "status": "PUBLISHED",
          "reply": "string",
          "repliedAt": "2026-09-25T10:00:00Z",
          "creationDateTime": "2026-09-25T10:00:00Z"
        }
      ]
    },
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Application submitted successfully"
}

Responses

Status	When
`200`	Application submitted successfully

POST Ask to view a unit

POST /rental/listing/{reference}/viewing-request

No account needed. The lister calls back on the number given. Rate limited by address, because a stranger's name and number reach the lister.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`X-Forwarded-For`
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: ViewingRequest · Response: GenericResponseViewingResponse

curl -X POST "https://api.bridgemoni.com/rental/listing/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/viewing-request" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "msisdn": "+2348000000000",
  "preferredAt": "2026-09-25T10:00:00Z"
}'

{
  "name": "string",
  "msisdn": "+2348000000000",
  "preferredAt": "2026-09-25T10:00:00Z"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "string",
    "msisdn": "+2348000000000",
    "preferredAt": "2026-09-25T10:00:00Z",
    "status": "REQUESTED",
    "decidedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Viewing requested successfully"
}

Responses

Status	When
`200`	Viewing requested successfully
`429`	Too many requests from this address

GET Viewing requests on your listing

GET /rental/listing/{reference}/viewings

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListViewingResponse

curl -X GET "https://api.bridgemoni.com/rental/listing/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/viewings" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "string",
      "msisdn": "+2348000000000",
      "preferredAt": "2026-09-25T10:00:00Z",
      "status": "REQUESTED",
      "decidedAt": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Viewings retrieved successfully"
}

Responses

Status	When
`200`	Viewings retrieved successfully

POST Withdraw a listing

POST /rental/listing/{reference}/withdraw

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListingResponse

curl -X POST "https://api.bridgemoni.com/rental/listing/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/withdraw" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "marketCode": "string",
    "area": "string",
    "city": "string",
    "propertyType": "string",
    "unitType": "string",
    "bedrooms": 0,
    "askingRent": 0,
    "currencyCode": "string",
    "rentCadence": "MONTHLY",
    "depositAmount": 0,
    "availableFrom": "2026-09-25",
    "description": "string",
    "listedBy": "OCCUPANT",
    "ownershipVerified": true,
    "status": "PUBLISHED",
    "publishedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Listing withdrawn successfully"
}

Responses

Status	When
`200`	Listing withdrawn successfully

GET Search listings

GET /rental/listings

Open to anyone, without an account, and rate limited by address. Filters are optional; the market is required.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`X-Forwarded-For`

Query parameters

Name	Default
`marketCode`	Optional
`area`	Optional
`maxRent`	Optional
`bedrooms`	Optional

Example

Response: GenericResponseListListingResponse

curl -X GET "https://api.bridgemoni.com/rental/listings?marketCode=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unitReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "propertyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "marketCode": "string",
      "area": "string",
      "city": "string",
      "propertyType": "string",
      "unitType": "string",
      "bedrooms": 0,
      "askingRent": 0,
      "currencyCode": "string",
      "rentCadence": "MONTHLY",
      "depositAmount": 0,
      "availableFrom": "2026-09-25",
      "description": "string",
      "listedBy": "OCCUPANT",
      "ownershipVerified": true,
      "status": "PUBLISHED",
      "publishedAt": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Listings retrieved successfully"
}

Responses

Status	When
`200`	Listings retrieved successfully
`429`	Too many requests from this address

POST Confirm or decline a viewing

POST /rental/viewing/{reference}/decision

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: ViewingDecisionRequest · Response: GenericResponseViewingResponse

curl -X POST "https://api.bridgemoni.com/rental/viewing/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/decision" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "confirmed": true
}'

{
  "confirmed": true
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "listingReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "string",
    "msisdn": "+2348000000000",
    "preferredAt": "2026-09-25T10:00:00Z",
    "status": "REQUESTED",
    "decidedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Viewing decided successfully"
}

Responses

Status	When
`200`	Viewing decided successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors