API ReferenceHouseholds

List Documents

List all documents

Path parameters

householdIdstringRequired
The id of the household

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of documents
householdIdstringformat: "uuid"
idstringformat: "uuid"
propertyIdstringformat: "uuid"
urlstring
createdAtdatetimeOptional
createdByUserIdstringOptionalformat: "uuid"
deletedAtdatetimeOptional
householdobjectOptional
idempotencyIdstringOptionalformat: "uuid"
isReviewedbooleanOptionalDefaults to false
Indicates if the document has been reviewed by compliance
mimeTypestringOptional
namestringOptional
notesstringOptional
organizationIdstringOptionalformat: "uuid"
propertyobjectOptional
readableIdstringOptional
typestringOptional
updatedAtdatetimeOptional