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
}
'import requests
url = "https://app.getaptly.com/api/portal/forms/searchLocations"
payload = {
"companyId": "<string>",
"query": "<string>",
"bedCount": 123,
"maxRent": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({companyId: '<string>', query: '<string>', bedCount: 123, maxRent: 123})
};
fetch('https://app.getaptly.com/api/portal/forms/searchLocations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.getaptly.com/api/portal/forms/searchLocations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => '<string>',
'query' => '<string>',
'bedCount' => 123,
'maxRent' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.getaptly.com/api/portal/forms/searchLocations"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"query\": \"<string>\",\n \"bedCount\": 123,\n \"maxRent\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.getaptly.com/api/portal/forms/searchLocations")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"query\": \"<string>\",\n \"bedCount\": 123,\n \"maxRent\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.getaptly.com/api/portal/forms/searchLocations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"query\": \"<string>\",\n \"bedCount\": 123,\n \"maxRent\": 123\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
]
}Forms
Search locations for form location picker
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
}
'import requests
url = "https://app.getaptly.com/api/portal/forms/searchLocations"
payload = {
"companyId": "<string>",
"query": "<string>",
"bedCount": 123,
"maxRent": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({companyId: '<string>', query: '<string>', bedCount: 123, maxRent: 123})
};
fetch('https://app.getaptly.com/api/portal/forms/searchLocations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.getaptly.com/api/portal/forms/searchLocations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyId' => '<string>',
'query' => '<string>',
'bedCount' => 123,
'maxRent' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.getaptly.com/api/portal/forms/searchLocations"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"query\": \"<string>\",\n \"bedCount\": 123,\n \"maxRent\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.getaptly.com/api/portal/forms/searchLocations")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"query\": \"<string>\",\n \"bedCount\": 123,\n \"maxRent\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.getaptly.com/api/portal/forms/searchLocations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"query\": \"<string>\",\n \"bedCount\": 123,\n \"maxRent\": 123\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
]
}⌘I