Read Household Leslie Configuration

GET

https://api.fortresstech.io/v1/households/:householdId/leslieConfiguration

GET

/v1/households/:householdId/leslieConfiguration

$ curl https://api.fortresstech.io/v1/households/householdId/leslieConfiguration

200Retrieved

1 {
2   "createdAt": "2024-01-15T09:30:00Z",
3   "disabledAt": "2024-01-15T09:30:00Z",
4   "disabledById": "disabledById",
5   "disabledReason": "disabledReason",
6   "disabledUntil": "2024-01-15T09:30:00Z",
7   "effectiveEnabled": true,
8   "enabled": true,
9   "household": {
10     "status": "APPLICANT",
11     "isUnderEviction": true,
12     "id": "id",
13     "readableId": "readableId",
14     "idempotencyId": "idempotencyId",
15     "createdAt": "2024-01-15T09:30:00Z",
16     "updatedAt": "2024-01-15T09:30:00Z",
17     "deletedAt": "2024-01-15T09:30:00Z",
18     "currentUnitId": "currentUnitId",
19     "currentLeaseId": "currentLeaseId",
20     "applicationId": "applicationId",
21     "organizationId": "organizationId",
22     "propertyId": "propertyId",
23     "currentCertificationId": "currentCertificationId",
24     "prospectId": "prospectId",
25     "primaryCustomerId": "primaryCustomerId",
26     "totalActiveRentAmount": 1.1,
27     "totalActiveSubsidyAmount": 1.1,
28     "totalActiveFeesAmount": 1.1,
29     "unitId": "unitId"
30   },
31   "householdId": "householdId",
32   "id": "id",
33   "isInQuietPeriod": true,
34   "updatedAt": "2024-01-15T09:30:00Z"
35 }

Available by Request

Read whether the Leslie integration is enabled for a specific household. If no configuration has been saved for the household yet, a default of enabled: true (and effectiveEnabled: true) is returned. Integrations should key off of effectiveEnabled rather than the raw enabled value, since effectiveEnabled accounts for a disabled quiet period (disabledUntil) that has since elapsed even though enabled still reflects the last saved value until it is explicitly re-enabled.

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

<Badge>Available by Request</Badge> Read whether the Leslie integration is enabled for a specific household. If no configuration has been saved for the household yet, a default of `enabled: true` (and `effectiveEnabled: true`) is returned. Integrations should key off of `effectiveEnabled` rather than the raw `enabled` value, since `effectiveEnabled` accounts for a disabled quiet period (`disabledUntil`) that has since elapsed even though `enabled` still reflects the last saved value until it is explicitly re-enabled. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

householdIdstringRequired

The id of the household

Response

Expected response to a valid request

createdAtdatetimeOptional

disabledAtdatetimeOptional

disabledByIdstringOptionalformat: "uuid"

disabledReasonstringOptional<=1000 characters

disabledUntildatetimeOptional

effectiveEnabledbooleanOptional

The value integrations should act on. This accounts for any quiet period that has since ended, and may differ from the raw enabled value.

enabledbooleanOptional

Whether the Leslie integration is enabled for this household.

householdobjectOptional

householdIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

isInQuietPeriodbooleanOptional

Whether a disabled quiet period is currently active for this household.

updatedAtdatetimeOptional