> ## 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 device references

> Returns the devices that this device is linked to, with the direction and key of each link.

Each item names the linked device, the direction of the link as seen from the device in the path, the connection `key`, and the ontology of the linked device. A link is stored on both devices, with opposite directions. See [Organize devices and points](https://docs.kodelabs.com/products/kode-api/guides/organize-devices-and-points.md#link-devices-to-each-other).


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/devices/{deviceId}/references
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}/devices/{deviceId}/references:
    get:
      tags:
        - Devices
      summary: List device references
      description: >-
        Returns the devices that this device is linked to, with the direction
        and key of each link.
      operationId: listDeviceReferences
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - $ref: '#/components/parameters/DeviceId'
        - name: asc
          in: query
          schema:
            type: string
          description: Field to sort ascending by.
        - description: Only links to devices of this ontology canonical type.
          name: canonicalType
          in: query
          schema:
            type: string
        - name: dsc
          in: query
          schema:
            type: string
            default: _id
          description: Field to sort descending by. Default `_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`. Default `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: q
          in: query
          schema:
            type: string
          description: Free-text search term.
      responses:
        '200':
          description: A page of linked devices.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEntityDeviceReferencePublic'
        '400':
          description: '`page` is below `1`, or `limit` is outside `1` to `200`.'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '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
    DeviceId:
      name: deviceId
      in: path
      required: true
      description: Device identifier.
      schema:
        type: string
      example: ahu-01
  schemas:
    PaginatedEntityDeviceReferencePublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DeviceReferencePublic'
        page:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        pageCount:
          type: integer
          format: int32
        itemCount:
          type: integer
          format: int32
    DeviceReferencePublic:
      type: object
      properties:
        device:
          $ref: '#/components/schemas/DeviceRef'
        type:
          $ref: '#/components/schemas/RefType'
        key:
          type: string
        ontology:
          $ref: '#/components/schemas/Ontology2'
    DeviceRef:
      type: object
      properties:
        _id:
          type: string
        name:
          type: string
    RefType:
      type: string
      enum:
        - INPUT
        - OUTPUT
    Ontology2:
      type: object
      properties:
        canonicalType:
          type: string
        entities:
          type: array
          items:
            type: string
  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.