External
Document Platform

List documents in a building

Get all documents in a specific building owned by a building owner

get/v1/building_owners/{buildingOwnerId}/buildings/{buildingId}/documents/

Request

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

Path parameters

buildingOwnerIdstring required
buildingIdstring required

Query parameters

next_tokenstring

Pagination token from previous response. Must use same sort_by/sort_order.

limitinteger required
sort_by'createdAt' | 'updatedAt' required
sort_order'asc' | 'desc' required
string date-time
OR
string date-time

Only return documents with updatedAt >= this value (ISO 8601). Requires sort_by=updatedAt.

include_url'true' | 'false'

Include signed download (url) and preview (previewUrl) URLs on each document. Limits limit to 200.

Response

Default Response

nextTokenstring nullable

Changes

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