> ## 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 tenants

> Returns the tenants of a building, one page at a time.

Use `status` to narrow the list. The value is case-sensitive. Repeat the parameter to match any of several statuses. A value that matches nothing returns an empty page.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/tenants
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/{buildingId}/tenants:
    get:
      tags:
        - Tenants
      summary: List tenants
      description: Returns the tenants of a building, one page at a time.
      operationId: listTenants
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - name: asc
          in: query
          schema:
            type: string
          description: Field to sort by, lowest first, for example `name`.
        - name: dsc
          in: query
          schema:
            type: string
            default: _id
          description: Field to sort by, highest first. Defaults to `_id`.
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
            maximum: 200
            minimum: 1
            default: 50
          description: Number of items per page, from `1` to `200`. The default is `50`.
        - name: page
          in: query
          schema:
            type: integer
            format: int32
            minimum: 1
            default: 1
          description: Page number to return. The first page is `1`.
        - name: status
          in: query
          schema:
            type: array
            items:
              type: string
          description: >-
            Return only tenants with this status, `active` or `inactive`. Repeat
            the parameter to match any of several statuses.
      responses:
        '200':
          description: >-
            A page of tenants. `itemCount` is the total number of tenants that
            match the filters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEntityTenantPublic'
        '400':
          description: >-
            A query parameter is invalid. For example, `limit` is above `200`,
            `page` is below `1`, or `buildingId` is blank.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The building does not exist or is not assigned to the service
            account. KODE API answers `403` in both cases so that building ids
            cannot be probed.
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    BuildingId:
      name: buildingId
      in: path
      required: true
      description: Building identifier from List buildings.
      schema:
        type: string
      example: 67c960faffaa42223163099e
  schemas:
    PaginatedEntityTenantPublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TenantPublic'
        page:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        pageCount:
          type: integer
          format: int32
        itemCount:
          type: integer
          format: int32
    TenantPublic:
      type: object
      properties:
        _id:
          description: Tenant identifier.
          type: string
        organizationId:
          type: string
        createdAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        updatedAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        name:
          description: Name of the tenant.
          type: string
        description:
          type: string
        type:
          description: Type of the tenant, for example `company`.
          type: string
        status:
          description: '`active` or `inactive`.'
          type: string
        buildingIds:
          description: Buildings the tenant belongs to.
          type: array
          items:
            type: string
        identifier:
          description: Your own identifier for the tenant.
          type: string
        logo:
          description: Logo of the tenant.
          type: string
        contactPerson:
          $ref: '#/components/schemas/ContactPerson2'
          description: Contact person of the tenant.
    Date:
      type: string
      description: >-
        Date and time in UTC, with a numeric offset and no colon, for example
        `2026-10-28T13:51:31+0000`.
      examples:
        - 2026-10-28T13:51:31+0000
    ContactPerson2:
      type: object
      properties:
        firstName:
          description: First name.
          type: string
        lastName:
          description: Last name.
          type: string
        email:
          description: Email address.
          type: string
        phone:
          description: Phone number.
          type: string
  responses:
    Unauthorized:
      description: The access token is missing, invalid, or expired. Request a new token.
    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.