List tenant-scoped properties
LogsGET /properties
Returns a cursor-paginated page of the tenant's properties (premises), each with its owning customer, address and cadastral details. Besides the filters below you can pass q for a text search, service_area_id, cadastral_code, limit (default 20, maximum 100) and after (the next_cursor of the previous page). Requires the business:properties:read permission.
Parameters
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
qResource-specific text search.
customer_idReturns only properties owned by this customer ID; omit it to list properties of every customer in the tenant.
statusReturns only properties in this status, either active or closed; omit it to include both.
Returns
200 Utility properties
Show attributes
dataShow child attributes
cadastral_codeUnique per tenant.
service_area_idaddress_line_2neighbourhoodcitypostal_codepremise_typeone of
residential,commercial,industrial,institutional,government,mixed,otheridtenant_idcustomer_idcustomer_nameDisplay name of the referenced customer. Omitted when unknown.
referenceaddress_linelocalitydistrictprovincelatitudelongitudestatus
has_morenext_cursor
Permissions business:properties:read · Roles: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/properties" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/properties", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/properties",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/properties", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"cadastral_code": "CAD-2026-000142",
"service_area_id": "ser_23fmkpfkC17kSVJ2spjyiBbOED9",
"address_line_2": "address line 2",
"neighbourhood": "neighbourhood",
"city": "Maputo",
"postal_code": "POS-2026-000142",
"premise_type": "residential",
"id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
"customer_name": "Ana Matsinhe",
"reference": "REF-2026-000142",
"address_line": "address line",
"locality": "locality",
"district": "district",
"province": "province",
"latitude": -25.9653,
"longitude": 32.5892,
"status": "active"
}
],
"has_more": true,
"next_cursor": "next cursor"
}