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 \
     -H "x-api-key: <apiKey>"

200Retrieved

{
  "isEnabled": true,
  "externalPropertyId": "string",
  "isConfigured": true,
  "settings": {},
  "propertyId": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "property": {
    "name": "string",
    "shortName": "string",
    "email": "string",
    "phone": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "mailingStreetAddress1": "string",
    "mailingStreetAddress2": "string",
    "mailingCity": "string",
    "mailingState": "string",
    "mailingZip": "string",
    "mailingCountry": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "timezone": "string",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "string",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  }
}

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

propertyIdstringRequiredformat: "uuid"

The id of the property

Response

Expected response to a valid request

isEnabledbooleanOptional

Whether the Leslie integration is enabled for this property

externalPropertyIdstring or nullOptional<=255 characters

Leslie's own identifier for this property

isConfiguredbooleanOptional

Derived field, true when isEnabled and externalPropertyId are both truthy

settingsobject or nullOptional

Freeform settings for the Leslie integration. Secret values within this object (any key whose name looks like a credential) are redacted on read and never returned by this or any other endpoint. They are set by Fortress staff; this surface is read-only.

propertyIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

readableIdstring or nullOptional

idempotencyIdstring or nullOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetime or nullOptional

propertyobjectOptional