Skip to main content

Description

Companies are the main operational unit. Each company manages its buildings, vehicles, consumptions and emissions.

Endpoints

Example: List companies

Common Parameters

  • page (optional): Page number
  • limit (optional): Items per page (max 1000)
  • query (optional): Search by name or external id
  • status (optional): Filter by status (accepted, pending, …)
  • isRootCompany (optional): Parent/root companies only (true) or non-root (false)
  • isTestCompany (optional): Test companies only (true) or exclude tests (false)
  • companyIds (optional): Filter by company IDs
To count without downloading all rows: limit=1 and read pagination.total.

Example: count active parent companies