> ## Documentation Index
> Fetch the complete documentation index at: https://docs.communityhub.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# BuildingOS

> BuildingOS data source — split out from the Data Sources overview

<Info>
  **Status: Full setup.** BuildingOS uses OAuth-style gateway credentials to authorize integrations, with a single `client_id` and `client_secret` per organization.
</Info>

<Steps>
  <Step title="Generate credentials">
    A privileged user generates a `client_id` and `client_secret` when registering or being invited to a BuildingOS integration. These are required before any data can be received.

    <Note>
      `client_id` is tied to the individual user who creates it, so multiple users within the same organization can each set up their own integrations independently.
    </Note>
  </Step>

  <Step title="Request an access token">
    Send a `POST` request to `https://api.buildingos.com/o/token/` using your `client_id` and `client_secret` to receive an access token.
  </Step>

  <Step title="Test the connection">
    Use the access token to `POST` to `https://api.buildingos.com/ping`. The endpoint echoes back the body you send, confirming the token works.
  </Step>

  <Step title="Configure meters and variables">
    Once connected, use BuildingOS's device drivers (for example, the Niagara4 "Vykon Workplace N4" driver) to sync using the gateway number, configure meters and submeters, and push variables into Data Hub.
  </Step>
</Steps>