v1
latestOpenAPI 3.0.12026-07-268028223.9 KBNotes
List notes
List all notes for a household
get/v1/households/{household_id}/notes
Query parameters
pageinteger
Page number
per_pageinteger
Items per page (1-100, default: 25). Values over 100 will be clamped to 100.
hiddenboolean
Filter by hidden status
pinnedboolean
Filter by pinned status
Response
successful
Example response
{
"data": [
{
"id": "abc123xyz",
"content": "Meeting notes from client discussion",
"book_id": "book123xyz",
"household_id": "household123xyz",
"created_by_id": "user123xyz"
}
],
"pagination": {
"current_page": 1,
"total_pages": 10,
"total_count": 100,
"per_page": 25
}
}