Skip to main content
POST
/
forms
/
searchLocations
Search locations for form location picker
curl --request POST \
  --url https://app.getaptly.com/api/portal/forms/searchLocations \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyId": "<string>",
  "query": "<string>",
  "bedCount": 123,
  "maxRent": 123
}
'
{
  "locations": [
    {
      "_id": "loc_xyz789",
      "name": "The Residences at Oak Creek - Unit 204",
      "companyId": "org_abc123",
      "address": {
        "formattedAddress": "123 Main St, Austin TX 78701",
        "state": "TX",
        "countryName": "United States"
      },
      "bedCount": 2,
      "bathCount": 1,
      "squareFeet": 950,
      "marketRent": "$1,500",
      "marketRentValue": 150000,
      "videoUrl": "<string>",
      "virtualTourUrl": "<string>",
      "applicationConfig": {
        "availableDate": "2026-04-01",
        "marketRent": "$1,500",
        "marketRentValue": 150000,
        "incomeToRent": 3,
        "marketingTitle": "<string>",
        "marketingBlurb": "<string>",
        "applicationRequirements": "<string>",
        "petRestrictions": "<string>",
        "leaseTerms": "<string>",
        "coverPhoto": [
          "<string>"
        ],
        "marketingImages": [
          "<string>"
        ],
        "agent": {
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "photo": "<string>"
        }
      },
      "companyInfo": {
        "requireBankConnect": true,
        "disableApplicantGuarantors": true,
        "disableBankScreening": true,
        "requireEmergencyContact": true,
        "applicationLock": "onClose",
        "enableSection8": true,
        "enableRegionalScreeningFilters": true,
        "collectPayment": true,
        "taxDocumentCount": 123,
        "bankStatementCount": 123,
        "payStubCount": 123,
        "toggleChatWindow": true
      }
    }
  ]
}

Body

application/json
​
companyId
string
required
​
query
string
​
bedCount
integer
​
maxRent
integer

Maximum rent in cents

Response

200 - application/json

Location results

​
locations
object[]