Document Platform

Get building freshness

Whether the building needs new documents, and whether to show this user the banner asking for them.

get/customers/{customerId}/buildings/{buildingId}/freshness

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/freshness
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
buildingIdstring uuid required

Response

Default Response

buildingIdstring uuid required
showBannerboolean required
needsDocumentsboolean required
reason'too_few_documents' | 'stale' nullable required
documentCountinteger required
documentStatus'active' | 'complete' required
snoozeCountinteger required
snoozesExhaustedboolean required
ignoredByUserboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.