External
Document Platform

List deleted documents

Documents deleted from any of the building owner’s buildings at or after deleted_since, oldest first. A key scoped to individual buildings receives only deletions in those buildings, so a page may hold fewer than limit items while nextToken is still set.

get/v1/building_owners/{buildingOwnerId}/documents/deleted

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/v1/building_owners/{buildingOwnerId}/documents/deleted
  • Auth: API key in header x-api-key

Path parameters

buildingOwnerIdstring required

Query parameters

string date-time required
OR
string date-time required

Return documents deleted at or after this time (ISO 8601). Results are oldest first, so the last deletedAt you receive is the next value to pass.

limitinteger required
next_tokenstring

Pagination token from previous response.

Response

Default Response

nextTokenstring nullable

Changes

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