Retrieve a tenancy
curl --request GET \
--url https://api.helloproper.com/tenancies/{tenancyId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.helloproper.com/tenancies/{tenancyId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helloproper.com/tenancies/{tenancyId}', 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://api.helloproper.com/tenancies/{tenancyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.helloproper.com/tenancies/{tenancyId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.helloproper.com/tenancies/{tenancyId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/tenancies/{tenancyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"address": {
"street": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"floor": "<string>",
"door": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>"
},
"groupId": {},
"currentLease": {
"id": "<string>",
"tenancyId": "<string>",
"operationalState": "<string>",
"contractPeriodState": "<string>",
"primaryTenantContactName": "<string>",
"tenantIds": [
{}
],
"associatedContactIds": [
{}
],
"primaryTenantId": "<string>",
"billingContactId": "<string>",
"balance": {
"currency": "<string>",
"amount": 123
},
"depositBalance": {
"currency": "<string>",
"amount": 123
},
"prepaidBalance": {
"currency": "<string>",
"amount": 123
},
"contractStart": "<string>",
"contractEnd": "<string>",
"purpose": "<string>",
"monthlyRentLevel": {
"currency": "<string>",
"amount": 123
},
"archivedAt": "<string>"
},
"leaseIds": [
{}
],
"unitType": "<string>",
"unitTypeName": "<string>",
"roomCounts": [
{
"type": "<string>",
"count": 123
}
],
"totalArea": {
"value": 123,
"unit": "<string>"
},
"businessArea": {
"value": 123,
"unit": "<string>"
},
"archivedAt": "<string>"
}Tenancies
Retrieve a tenancy
GET
/
tenancies
/
{tenancyId}
Retrieve a tenancy
curl --request GET \
--url https://api.helloproper.com/tenancies/{tenancyId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.helloproper.com/tenancies/{tenancyId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.helloproper.com/tenancies/{tenancyId}', 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://api.helloproper.com/tenancies/{tenancyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.helloproper.com/tenancies/{tenancyId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.helloproper.com/tenancies/{tenancyId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/tenancies/{tenancyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"address": {
"street": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"floor": "<string>",
"door": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>"
},
"groupId": {},
"currentLease": {
"id": "<string>",
"tenancyId": "<string>",
"operationalState": "<string>",
"contractPeriodState": "<string>",
"primaryTenantContactName": "<string>",
"tenantIds": [
{}
],
"associatedContactIds": [
{}
],
"primaryTenantId": "<string>",
"billingContactId": "<string>",
"balance": {
"currency": "<string>",
"amount": 123
},
"depositBalance": {
"currency": "<string>",
"amount": 123
},
"prepaidBalance": {
"currency": "<string>",
"amount": 123
},
"contractStart": "<string>",
"contractEnd": "<string>",
"purpose": "<string>",
"monthlyRentLevel": {
"currency": "<string>",
"amount": 123
},
"archivedAt": "<string>"
},
"leaseIds": [
{}
],
"unitType": "<string>",
"unitTypeName": "<string>",
"roomCounts": [
{
"type": "<string>",
"count": 123
}
],
"totalArea": {
"value": 123,
"unit": "<string>"
},
"businessArea": {
"value": 123,
"unit": "<string>"
},
"archivedAt": "<string>"
}Params
string
required
Tenancy id
Response
string
The unique identifier for the tenancy
object
The address details of the tenancy
Show child attributes
Show child attributes
string
The full street name and number
string
The name of the street
string
The number of the property on the street
string
The floor of the address if applicable
string
The door of the address if applicable
string
The subdivision of the address if applicable
string
The postal code for the address
string
The city of the address
string
The country code of the address
object
Categories mapped to the corresponding groups
object
The details of the Current Lease Object for the tenancy
Show child attributes
Show child attributes
string
The unique identifier for the lease
string
The identifier for the tenancy associated with the lease
string
The operational state of the lease (e.g., “Draft”)
string
The state of the contract period (e.g., “Active”)
string
The name of the primary tenant contact
array
The identifiers for the tenants
array
The identifiers for the associated contacts
string
The identifier for the primary tenant
string
The identifier for the billing contact
object
object
object
date
The start date of the contract in ISO 8601 format
date
The end date of the contract in ISO 8601 format
string
The purpose of the lease (e.g., “key:residential”)
object
date
The date-time in ISO 8601 format of archiving the lease
array
The identifiers for all leases associated with the tenancy
string
The type of the unit (e.g., “PARKING”)
string
The description of unit type, if unit type is “OTHER”
array
object
object
date
The date-time in ISO 8601 format of archiving the tenancy
⌘I