Read Household Cora Configuration

Available by Request

Read whether the document-review agent (CORA) integration is enabled for a specific household. Same contract as the household Leslie configuration. Read-only for agents. If no configuration has been saved for the household yet, enabled: true and effectiveEnabled: true are returned. Key off effectiveEnabled, which accounts for a disabled quiet period (disabledUntil) that has since elapsed.

Manual Compliance Review state is a separate read: GET /households/{householdId}/complianceReview.

This endpoint is part of the document-review agent surface. To explore availability for your integration, please contact our team.

<Badge>Available by Request</Badge> Read whether the document-review agent (CORA) integration is enabled for a specific household. Same contract as the household Leslie configuration. Read-only for agents. If no configuration has been saved for the household yet, `enabled: true` and `effectiveEnabled: true` are returned. Key off `effectiveEnabled`, which accounts for a disabled quiet period (`disabledUntil`) that has since elapsed. Manual Compliance Review state is a separate read: `GET /households/{householdId}/complianceReview`. <Note> This endpoint is part of the document-review agent surface. 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

idstringOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

enabledbooleanOptional

Last saved value.

effectiveEnabledbooleanOptional

The value to act on. Accounts for a disabled quiet period (disabledUntil) that has since elapsed.

isInQuietPeriodbooleanOptional

disabledReasonstringOptional<=1000 characters

disabledByIdstringOptionalformat: "uuid"

disabledAtdatetimeOptional

disabledUntildatetimeOptional

createdAtdatetimeOptional

updatedAtdatetimeOptional

Errors

404

Read Household Cora Configuration Request Not Found Error