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

# Get a connector

> Returns one connector of a building, with the kinds of data it handles.

`entities` lists the kinds of data the connector holds. A new KODE API connector reports `DEVICES` and `ASSETS`. This endpoint does not return the connection status. Use [Get connector status](https://docs.kodelabs.com/products/kode-api/api-reference/connectors/get-connector-status.md) for that.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/connectors/{connectorId}
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}/connectors/{connectorId}:
    get:
      tags:
        - Connectors
      summary: Get a connector
      description: Returns one connector of a building, with the kinds of data it handles.
      operationId: getConnector
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - name: connectorId
          in: path
          required: true
          schema:
            type: string
          description: >-
            ID of the connector. It is the `_id` from [Create a KODE API
            connector](/products/kode-api/api-reference/connectors/create-a-kode-api-connector)
            or [List
            connectors](/products/kode-api/api-reference/connectors/list-connectors).
      responses:
        '200':
          description: The connector.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorPublic'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The building does not exist, is not available to your service
            account, or has no `api` product enabled.
        '404':
          description: >-
            No connector with this id exists in this building. A connector of
            another building returns `404` too.
        '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:
    ConnectorPublic:
      type: object
      properties:
        _id:
          type: string
        organizationId:
          type: string
        createdAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        updatedAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        name:
          type: string
        integrationType:
          type: string
        disabled:
          type: boolean
        systemTypes:
          type: array
          items:
            type: string
        entities:
          type: array
          items:
            $ref: '#/components/schemas/Entity'
    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
    Entity:
      type: string
      enum:
        - DEVICES
        - SCHEDULES
        - ASSETS
  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.