## List all documents in a household

`households.list_documents(strid, HouseholdListDocumentsParams**kwargs)  -> SyncCursorPagination[Document]`

**get** `/households/{id}/documents`

Retrieve a paginated list of documents belonging to a specific household

### Parameters

- `id: str`

- `after: Optional[str]`

  Cursor for forward pagination. Returns items after this cursor.

- `before: Optional[str]`

  Cursor for backward pagination. Returns items before this cursor.

- `limit: Optional[int]`

  Maximum number of items to return

- `type: Optional[DocumentType]`

  Filter by document type

  - `"GRAT_DESIGN_SUMMARY"`

  - `"GENERATED_PRESENTATION"`

  - `"ASSET_VALUATION"`

  - `"SIGNED_TRUST_DOCUMENT"`

  - `"TRUST_AMENDMENT"`

  - `"TRANSFER_CONFIRMATION"`

  - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

  - `"BALANCE_SHEET"`

  - `"WILL"`

  - `"WILL_CODICIL"`

  - `"POWER_OF_ATTORNEY"`

  - `"ASSIGNMENT_OF_INTEREST"`

  - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

  - `"LOAN_NOTE_AGREEMENT"`

  - `"ARTICLES_OF_INCORPORATION"`

  - `"OPERATING_AGREEMENT"`

  - `"PARTNERSHIP_AGREEMENT"`

  - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

  - `"TAX_ID_CONFIRMATION"`

  - `"GIFT_TAX_RETURN"`

  - `"INCOME_TAX_RETURN"`

  - `"TAX_RECEIPT"`

  - `"TAX_FILING"`

  - `"CORPORATE_BYLAWS"`

  - `"LLC_AGREEMENT"`

  - `"LLC_AGREEMENT_AMENDMENT"`

  - `"OPERATING_AGREEMENT_AMENDMENT"`

  - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

  - `"SHAREHOLDERS_AGREEMENT"`

  - `"STATE_BUSINESS_FILING"`

  - `"LOGGED_CONTRIBUTION"`

  - `"LOGGED_DISTRIBUTION"`

  - `"INSURANCE_POLICY"`

  - `"CRUMMEY_LETTER"`

  - `"INSURANCE_PREMIUM_PAYMENT"`

  - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

  - `"FINCEN_FILING"`

  - `"HEALTHCARE_PROXY"`

  - `"LIVING_WILL"`

  - `"DRIVERS_LICENSE"`

  - `"PASSPORT"`

  - `"DEED"`

  - `"OTHER"`

### Returns

- `class Document: …`

  - `id: str`

    Unique identifier with document_ prefix

  - `created_at: datetime`

    Timestamp when the document was created

  - `household_id: str`

    Household ID this document belongs to

  - `name: str`

    Display name of the document

  - `type: DocumentType`

    Type of document

    - `"GRAT_DESIGN_SUMMARY"`

    - `"GENERATED_PRESENTATION"`

    - `"ASSET_VALUATION"`

    - `"SIGNED_TRUST_DOCUMENT"`

    - `"TRUST_AMENDMENT"`

    - `"TRANSFER_CONFIRMATION"`

    - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

    - `"BALANCE_SHEET"`

    - `"WILL"`

    - `"WILL_CODICIL"`

    - `"POWER_OF_ATTORNEY"`

    - `"ASSIGNMENT_OF_INTEREST"`

    - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

    - `"LOAN_NOTE_AGREEMENT"`

    - `"ARTICLES_OF_INCORPORATION"`

    - `"OPERATING_AGREEMENT"`

    - `"PARTNERSHIP_AGREEMENT"`

    - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

    - `"TAX_ID_CONFIRMATION"`

    - `"GIFT_TAX_RETURN"`

    - `"INCOME_TAX_RETURN"`

    - `"TAX_RECEIPT"`

    - `"TAX_FILING"`

    - `"CORPORATE_BYLAWS"`

    - `"LLC_AGREEMENT"`

    - `"LLC_AGREEMENT_AMENDMENT"`

    - `"OPERATING_AGREEMENT_AMENDMENT"`

    - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

    - `"SHAREHOLDERS_AGREEMENT"`

    - `"STATE_BUSINESS_FILING"`

    - `"LOGGED_CONTRIBUTION"`

    - `"LOGGED_DISTRIBUTION"`

    - `"INSURANCE_POLICY"`

    - `"CRUMMEY_LETTER"`

    - `"INSURANCE_PREMIUM_PAYMENT"`

    - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

    - `"FINCEN_FILING"`

    - `"HEALTHCARE_PROXY"`

    - `"LIVING_WILL"`

    - `"DRIVERS_LICENSE"`

    - `"PASSPORT"`

    - `"DEED"`

    - `"OTHER"`

  - `updated_at: datetime`

    Timestamp when the document was last updated

  - `enable_ai_suggestions: Optional[bool]`

    Whether this document should be used for AI suggestions

  - `entity_id: Optional[str]`

    Entity ID if this document is owned by an entity

  - `individual_id: Optional[str]`

    Individual ID if this document is associated with an individual

### Example

```python
from withluminary import Luminary

client = Luminary()
page = client.households.list_documents(
    id="id",
)
page = page.data[0]
print(page.id)
```

#### Response

```json
{
  "data": [
    {
      "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "name": "Trust Agreement.pdf",
      "type": "GRAT_DESIGN_SUMMARY",
      "updated_at": "2024-01-20T14:45:00Z",
      "enable_ai_suggestions": true,
      "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}
```