List properties
the properties in your Breezeway account, with ID, name and address.
GET https://cotlet.dev/api/v1/breezeway/properties
read
Returns each property with its ID, name and address, in the order the Properties page shows them. The property ID is what list_tasks and create_task take. Cross-company accounts see the company that is open in the app.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Part of a property name or address. |
Request
curl https://cotlet.dev/api/v1/breezeway/properties \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("breezeway", "list_properties")const result = await cotlet.call('breezeway', 'list_properties');cotlet call breezeway list_propertiesExample response
{
"properties": [
{
"property_id": 16052,
"name": "Harbor View 4",
"address": "12 Harbor Street"
},
{
"property_id": 16077,
"name": "Maple Cabin",
"address": "8 Maple Lane"
}
]
}