academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Buildings → List buildings

AI-generated

Summary

Retrieve a list of buildings matching optional pagination, filtering, and sorting criteria from the academyFIVE API.

Inputs

  • page(number) — Specify the page number for pagination, starting at 1. Defaults to 1 if not set.
  • page(size) — Define the number of results per page. Defaults to 50 if not set.
  • filter(ids) — Filter buildings by a comma-separated list of building IDs.
  • filter(leadingSiteId) — Filter buildings by the ID of their leading site.
  • filter(approvedSiteId) — Filter buildings by site ID in their approved (shared) sites.
  • filter(active) — Filter buildings by active status. Use 1/true for active, 0/false for inactive.
  • sort — Sort results by fields such as id, name, active, leadingSiteName, or roomCount; prefix with '-' for descending order.
  • include — Include related resources by specifying a comma-separated list of relationship names (e.g., sites).

Output shape

a list of building records corresponding to the applied filters and pagination settings

The operation returns JSON arrays of building data; if an error occurs and 'Continue On Fail' is enabled, error information per item will be included in output. Pagination parameters default if not provided. Filtering and sorting parameters are optional and can be combined.

Links

Discussion