Read Property Leslie Configuration

GET

https://api.fortresstech.io/v1/properties/:propertyId/leslieConfiguration

GET

/v1/properties/:propertyId/leslieConfiguration

$ curl https://api.fortresstech.io/v1/properties/propertyId/leslieConfiguration

200Retrieved

1 {
2   "createdAt": "2024-01-15T09:30:00Z",
3   "deletedAt": "2024-01-15T09:30:00Z",
4   "externalPropertyId": "externalPropertyId",
5   "id": "id",
6   "idempotencyId": "idempotencyId",
7   "isConfigured": true,
8   "isEnabled": true,
9   "property": {
10     "name": "name",
11     "shortName": "shortName",
12     "email": "email",
13     "phone": "phone",
14     "physicalStreetAddress1": "physicalStreetAddress1",
15     "physicalStreetAddress2": "physicalStreetAddress2",
16     "physicalCity": "physicalCity",
17     "physicalState": "physicalState",
18     "physicalZip": "physicalZip",
19     "physicalCountry": "physicalCountry",
20     "mailingStreetAddress1": "mailingStreetAddress1",
21     "mailingStreetAddress2": "mailingStreetAddress2",
22     "mailingCity": "mailingCity",
23     "mailingState": "mailingState",
24     "mailingZip": "mailingZip",
25     "mailingCountry": "mailingCountry",
26     "phoneNumber": "phoneNumber",
27     "faxNumber": "faxNumber",
28     "timezone": "timezone",
29     "longitude": 1.1,
30     "latitude": 1.1,
31     "turnMoveOutDays": 1,
32     "status": "ACTIVE",
33     "propertyClass": "Conventional",
34     "organizationId": "organizationId",
35     "id": "id",
36     "readableId": "readableId",
37     "idempotencyId": "idempotencyId",
38     "createdAt": "2024-01-15T09:30:00Z",
39     "updatedAt": "2024-01-15T09:30:00Z",
40     "deletedAt": "2024-01-15T09:30:00Z",
41     "offboardedAt": "2024-01-15T09:30:00Z",
42     "countyName": "countyName",
43     "acquisitionDate": "2024-01-15T09:30:00Z"
44   },
45   "propertyId": "propertyId",
46   "readableId": "readableId",
47   "settings": {
48     "key": "value"
49   },
50   "updatedAt": "2024-01-15T09:30:00Z",
51   "webhookUrl": "webhookUrl"
52 }

Available by Request

Info for a property’s Leslie integration configuration

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

<Badge>Available by Request</Badge> Info for a property's Leslie integration configuration <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

propertyIdstringRequired

The id of the property

Response

Expected response to a valid request

createdAtdatetimeOptional

deletedAtdatetimeOptional

externalPropertyIdstringOptional<=255 characters

Leslie's own identifier for this property

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

isConfiguredbooleanOptional

Derived field, true when isEnabled and externalPropertyId are both truthy

isEnabledbooleanOptional

Whether the Leslie integration is enabled for this property

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

settingsmap from strings to anyOptional

Freeform settings for the Leslie integration. Secret values within this object (for example a validation key) are redacted on read and never returned by this or any other endpoint — they can only be written, via the upsert operation.

updatedAtdatetimeOptional

webhookUrlstringOptionalformat: "uri"<=2048 characters

The URL Leslie should call to deliver webhook events for this property