academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Buildings → List buildings

AI-generated

Summary

Lists academyFIVE buildings, with optional filters, sorting, relationship inclusion, and pagination passed as query parameters.

Inputs

  • page[number] — Page number, starting at 1; the API default is 1.
  • page[size] — Number of results per page; the API default is 50.
  • filter[ids] — Comma-separated building IDs to return.
  • filter[leadingSiteId] — Filter by the ID of the building’s leading site.
  • filter[approvedSiteId] — Filter buildings with the given ID among their approved (shared) sites.
  • filter[active] — Filter by active status; use 1/true for active or 0/false for inactive.
  • sort — Sort by id, name, active, leadingSiteName, or roomCount; prefix a field with - for descending order. Unknown fields are ignored.
  • include — Comma-separated relationships to include in the response, such as sites.

Output shape

A list of JSON items representing buildings.

The API response is converted to n8n JSON items. Pagination parameters select a page; this operation does not show automatic pagination. If Continue On Fail is enabled, a failed request returns an item with an error field.

Links

Discussion