> ## 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 units by category

> Returns every unit that the KODE ontology defines, grouped by unit category. Use it to pick a valid `unit` override for a templating plan.

Each category, such as `temperature`, holds its units with a `symbol`, `name`, and the values the ontology uses to convert a value to the category's base unit (`multiplier` and `offset`). A unit override in a templating plan must belong to the same category as the field it changes. The `unit.category` of a field in [List fields for a canonical type](https://docs.kodelabs.com/products/kode-api/api-reference/ontology/list-fields-for-a-canonical-type.md) tells you which category that is.

The list is the same for the whole organization.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/ontology/units
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/ontology/units:
    get:
      tags:
        - Ontology
      summary: List units by category
      description: >-
        Returns every unit that the KODE ontology defines, grouped by unit
        category. Use it to pick a valid `unit` override for a templating plan.
      operationId: listOntologyUnits
      responses:
        '200':
          description: The units, grouped by category.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEntityOntologyUnitCategoryPublic'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    PaginatedEntityOntologyUnitCategoryPublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OntologyUnitCategoryPublic'
        page:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        pageCount:
          type: integer
          format: int32
        itemCount:
          type: integer
          format: int32
    OntologyUnitCategoryPublic:
      type: object
      properties:
        name:
          type: string
          description: Unit category name.
          examples:
            - temperature
        units:
          type: array
          items:
            $ref: '#/components/schemas/OntologyUnitPublic'
          description: Every unit kode-ontology defines under this category.
    OntologyUnitPublic:
      type: object
      properties:
        id:
          type: string
          description: Catalog id of the unit.
          examples:
            - 60f1a2b3c4d5e6f7a8b9c0d1
        symbol:
          type: string
          description: Unit symbol, as used on point/field definitions.
          examples:
            - °F
        name:
          type: string
          description: Human-readable unit name.
          examples:
            - Degree Fahrenheit
        category:
          type: string
          description: Unit category (the grouping key of the parent catalog entry).
          examples:
            - temperature
        covTolerance:
          type: number
          format: double
          description: >-
            Default COV tolerance kode-ontology suggests for points in this
            unit.
          examples:
            - 0.5
        precision:
          type: integer
          format: int32
          description: Default display precision kode-ontology suggests for this unit.
          examples:
            - 1
        keywords:
          type: array
          uniqueItems: true
          items:
            type: string
          description: Search keywords for this unit (matched by catalog search).
          examples:
            - - fahrenheit
              - deg f
        multiplier:
          type: number
          format: double
          description: >-
            Multiplier used to convert a value in this unit to the category's
            base unit.
          examples:
            - 0.5555555555555556
        offset:
          type: number
          format: double
          description: >-
            Offset used to convert a value in this unit to the category's base
            unit.
          examples:
            - -17.77777777777778
        standard:
          type: boolean
          description: Whether this is one of kode-ontology's standard (non-custom) units.
          examples:
            - true
        type:
          type: string
          description: Unit type, as classified by kode-ontology.
          examples:
            - standard
  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.