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

# List buildings

> Returns the buildings available to the authenticated service account.

> [!TIP]
>
> Call this endpoint first to confirm that your token works and to get the `buildingId` values used by other endpoints.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings
openapi: 3.1.0
info:
  title: KODE API
  version: 1.0.0
  summary: Programmatic access to KODE OS resources and operations.
  description: >
    Use the KODE API to work with buildings, data sources, connectors, devices,
    points, virtual devices,

    timeseries data, schedules, the ontology, templating, mass writes, spaces,
    space assignments, tenants, meters, users, actions,

    and AssetOps work orders.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.kodelabs.com/kodeos
    description: KODE API
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: OAuth 2.0 discovery, token, and revocation endpoints.
  - name: Buildings
    description: Buildings and their areas.
  - name: Data sources
    description: Data sources connected to a building.
  - name: Devices
    description: Devices and their points.
  - name: Points
    description: Point queries and point writes.
  - name: Timeseries
    description: Current and historical point values.
  - name: Actions
    description: Actions exposed by building data sources.
  - name: Work orders
    description: AssetOps work orders, lookups, comments, and attachments.
  - name: Connectors
    description: KODE API connectors and the devices and points ingested through them.
  - name: Schedules
    description: Schedules discovered on building data sources.
  - name: Templating
    description: Apply ontology templates to groups of points.
  - name: Virtual devices
    description: Virtual devices that group points from other devices.
  - name: Ontology
    description: Canonical types, fields, units, and connections of the KODE ontology.
  - name: Users
    description: Users of the organization and their app access.
  - name: Mass write
    description: Write values to many points across buildings, and follow each run.
  - name: Spaces
    description: Levels and space units of a building, and the meters located in them.
  - name: Space assignments
    description: Assign tenants to leasable spaces of a building for a period.
  - name: Tenants
    description: Tenants of a building, the people or companies that lease its spaces.
  - name: Meters
    description: >-
      Meters of a building, their space assignments, parent and child links, and
      readings.
paths:
  /api/v1/buildings:
    get:
      tags:
        - Buildings
      summary: List buildings
      description: Returns the buildings available to the authenticated service account.
      operationId: listBuildings
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - name: buildingId
          in: query
          description: Return only the building with this identifier.
          schema:
            type: string
          example: 67c960faffaa42223163099e
        - $ref: '#/components/parameters/AcceptLanguage'
      responses:
        '200':
          description: A page of buildings.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Pagination'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Building'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    Page:
      name: page
      in: query
      description: Page number to return. The first page is `1`.
      schema:
        type: integer
        minimum: 1
        default: 1
    Limit:
      name: limit
      in: query
      description: Maximum number of items per page.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    AcceptLanguage:
      name: accept-language
      in: header
      description: Locale for the response.
      schema:
        type: string
      example: en-US
  schemas:
    Pagination:
      type: object
      properties:
        itemCount:
          type: integer
          description: Total number of matching items.
          example: 1
        limit:
          type: integer
          description: Maximum number of items per page.
          example: 50
        page:
          type: integer
          description: Current page number.
          example: 1
        pageCount:
          type: integer
          description: Total number of pages.
          example: 1
    Building:
      type: object
      title: Building
      properties:
        _id:
          type: string
          example: 67c960faffaa42223163099e
        createdAt:
          type: string
          example: 2025-03-06T08:46:50+0000
        updatedAt:
          type: string
          example: 2025-03-06T10:06:14+0000
        name:
          type: string
          example: KODE OS Office
        address:
          type: object
          properties:
            address1:
              type: string
              example: 1420 Washington Boulevard
            address2:
              type: string
              example: ''
            city:
              type: string
              example: Detroit
            state:
              type: string
              example: Michigan
            stateAbbr:
              type: string
              example: MI
            country:
              type: string
              example: United States
            countryAbbr:
              type: string
              example: US
            zip:
              type: string
              example: '48226'
            location:
              type: object
              properties:
                lat:
                  type: number
                  example: 42.334056
                lng:
                  type: number
                  example: -83.0504911
        area:
          type: object
          description: Building floor area.
          properties:
            _id:
              type: string
              example: square_foot
            unit:
              type: string
              example: ft²
            value:
              type: number
              example: 10000
        primaryFunction:
          type: string
          example: Office
        tz:
          type: string
          description: IANA timezone of the building.
          example: America/Detroit
        picture:
          type: string
        areasCount:
          type: integer
          example: 4
        devicesCount:
          type: integer
          example: 120
        pointsCount:
          type: integer
          example: 2400
        systemsCount:
          type: integer
          example: 8
  responses:
    Unauthorized:
      description: The access token is missing, invalid, or expired. Request a new token.
    Forbidden:
      description: The service account lacks permission for this building or operation.
    TooManyRequests:
      description: >-
        A rate-limit window is exhausted. Wait, then retry with increasing
        delays.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Paste an access token from [Create an access
        token](/products/kode-api/api-reference/authentication/create-an-access-token).
        Tokens expire, so request a new one if you receive `401`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.