Skip to content

Marketing

Operations for retrieving marketing listings for external display and embedding on websites

Operations

Get marketing listings

Request

Retrieve marketing listings for a specific account. This endpoint is designed for embedding listings on external websites and marketing platforms.

Security
BearerAuth
Path
accountIdstring, (uuid)required

The account ID to retrieve listings for

Example:4b88ff32-8ba0-4bbf-8e60-c789909ac176
Query
utm_sourcestring

UTM source parameter for tracking

Example:utm_source=website_widget
limitinteger, [ 1 .. 100 ]

Maximum number of items to return per page (default 50, max 100)

Default:50
Example:limit=25
page_numberinteger, >= 0

Page number for pagination (0-indexed, default 0)

Default:0
Example:page_number=1
curl -i -X GET \
  'https://docs.rentengine.io/_mock/openapi/openapi/marketing/listings/4b88ff32-8ba0-4bbf-8e60-c789909ac176?utm_source=website_widget&limit=25&page_number=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns a list of marketing listings.

Bodyapplication/json
Array [
idstringrequired

Unique identifier for the listing

Example:"12345"
emailstring

Contact email for the listing

Example:"leasing@example.com"
phonestring

Contact phone number (digits only)

Example:"5551234567"
propertyTypestringrequired

Type of property

Enum:"Single Family""Duplex""Apartment Unit""Condo Unit""Townhouse""ADU""Room""Commercial Office""Commercial Retail""Commercial Industrial"
Example:"Single Family"
companyNamestring

Name of the property management company

Example:"ABC Property Management"
addressstringrequired

Formatted address

Example:"123 Main St #2"
citystringrequired

City name

Example:"San Francisco"
statestringrequired

Full state name

Example:"California"
zipstringrequired

ZIP code

Example:"94111"
titlestring

Marketing title for the listing

Example:"Beautiful 3BR Home in Prime Location"
descriptionstring

Marketing description of the property

Example:"Spacious 3 bedroom home with modern amenities..."
bedsstringrequired

Number of bedrooms

Example:"3"
bathsstringrequired

Number of bathrooms

Example:"2"
dateAvailablestring

Date the property is available for move-in

Example:"1/15/2024"
rentAmountstringrequired

Monthly rent amount in dollars

Example:"2500.23"
depositAmountstring

Security deposit amount in dollars

Example:"2500.23"
squareFootagestring

Square footage of the property

Example:"1500"
latitudenumber or null

Latitude coordinate

Example:37.7749
longitudenumber or null

Longitude coordinate

Example:-122.4194
applicationFeestring

Application fee amount in dollars

Example:"50"
leaseProcessingFeestring

Total lease processing/move-in fees in dollars

Example:"150.00"
isFurnishedboolean

Whether the property is furnished

Example:false
dogsboolean

Whether dogs are allowed

Example:true
catsboolean

Whether cats are allowed

Example:true
applyUrlstring

URL to apply for the listing

Example:"https://rentengine.io/listings/12345"
btnUrlstring

URL for the schedule showing button

Example:"https://app.rentengine.io/ss/12345"
btnTextstring

Text for the call-to-action button

Example:"Schedule a Showing"
waitlistIconstring

Icon identifier for waitlist status

Example:"snooze"
waitlistLabelstring

Label for waitlist status

Example:"Wait List"
waitlistTurnOffDatestring

Date when waitlist status ends

Example:"2024-02-01"
virtualTourstring or null

URL for virtual tour video

Example:"https://www.youtube.com/watch?v=abc123"
pmNamestring

Property manager name

Example:"ABC Property Management"
pmEmailstring

Property manager email

Example:"pm@example.com"
pmPhonestring

Property manager phone (digits only)

Example:"5551234567"
externalIdstring

External system identifier

Example:"EXT-12345"
propertyGroupstring or null

Property group identifier

Example:null
leaseDescriptionstring

Description of lease terms

Example:"12 months"
moveInFeesArray of objects

One-time fees required at move-in

Example:
[
  {
    "name": "Admin Fee",
    "amount": 150,
    "type": "dollar"
  }
]
monthlyFeesArray of objects

Recurring monthly fees in addition to rent

Example:
[
  {
    "name": "Pet Fee",
    "amount": 50,
    "type": "dollar"
  }
]
specialsArray of objects

Move-in specials and promotional offers. Combines specials from the unit, floorplan, and multifamily property (if applicable). Expired specials are filtered out. When end_date is omitted, the special has no end date (ongoing). Public listing pages should conditionally show the date range only when end_date is present.

Example:
[
  {
    "description": "First month free!",
    "start_date": "2024-01-01",
    "end_date": "2024-03-31"
  },
  {
    "description": "$500 off move-in costs",
    "start_date": "2024-01-15"
  }
]
photosArray of stringsrequired

Array of photo URLs

Example:
[
  "https://storage.example.com/images/photo1.jpg",
  "https://storage.example.com/images/photo2.jpg"
]
]
Response
[
  {
    "id": "12345",
    "email": "leasing@example.com",
    "phone": "5551234567",
    "propertyType": "Single Family",
    "companyName": "ABC Property Management",
    "address": "123 Main St #2",
    "city": "San Francisco",
    "state": "California",
    "zip": "94111",
    "title": "Beautiful 3BR Home in Prime Location",
    "description": "Spacious 3 bedroom home with modern amenities...",
    "beds": "3",
    "baths": "2",
    "dateAvailable": "1/15/2024",
    "rentAmount": "2500.23",
    "depositAmount": "2500.23",
    "squareFootage": "1500",
    "latitude": 37.7749,
    "longitude": -122.4194,
    "applicationFee": "50",
    "leaseProcessingFee": "150.00",
    "isFurnished": false,
    "dogs": true,
    "cats": true,
    "applyUrl": "https://rentengine.io/listings/12345",
    "btnUrl": "https://app.rentengine.io/ss/12345",
    "btnText": "Schedule a Showing",
    "waitlistIcon": "snooze",
    "waitlistLabel": "Wait List",
    "waitlistTurnOffDate": "2024-02-01",
    "virtualTour": "https://www.youtube.com/watch?v=abc123",
    "pmName": "ABC Property Management",
    "pmEmail": "pm@example.com",
    "pmPhone": "5551234567",
    "externalId": "EXT-12345",
    "propertyGroup": null,
    "leaseDescription": "12 months",
    "moveInFees": [ … ],
    "monthlyFees": [ … ],
    "specials": [ … ],
    "photos": [ … ]
  }
]