> ## 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 point write state

> Returns the priority level currently in effect on a point, read live from the data source.

The level in effect is the lowest level number that holds a value. KODE OS reads it from the data source on each request, the same way as [Get point priority array](https://docs.kodelabs.com/products/kode-api/api-reference/points/get-point-priority-array.md).

The response has one of three shapes:

* **A level is in effect:** `supported` is `true`, and `activeLevel`, `value`, and `who` describe that level.
* **No level holds a value:** `supported` and `relinquishDefault` are `true`, and the other fields are `null`. The point is at its relinquish default. The default value itself is not returned.
* **Not supported:** `supported` is `false` when the point is not writable, or its connector cannot write to points or has been deleted. The other fields are `null` or `false`.

A connector that does not keep a priority array for the point also returns `relinquishDefault: true`.

This endpoint only reads. It does not write a value or release a level.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/integrations/points/{pointId}/write-state
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}/integrations/points/{pointId}/write-state:
    get:
      tags:
        - Points
      summary: Get point write state
      description: >-
        Returns the priority level currently in effect on a point, read live
        from the data source.
      operationId: getPointWriteState
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - $ref: '#/components/parameters/PointId'
      responses:
        '200':
          description: The write state of the point.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WriteStatePublic'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: No point with this id exists in the building.
        '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
    PointId:
      name: pointId
      in: path
      required: true
      description: Point identifier.
      schema:
        type: string
      example: zone-temp-setpoint
  schemas:
    WriteStatePublic:
      type: object
      properties:
        supported:
          type: boolean
          description: >-
            `false` when the point is not writable, or its connector cannot
            write to points or has been deleted.
          example: true
        activeLevel:
          type:
            - integer
            - 'null'
          format: int32
          description: >-
            The level in effect. `null` when no level holds a value or the point
            is not supported.
          example: 8
        value:
          type:
            - string
            - 'null'
          description: Value held at the level in effect.
          example: '72'
        who:
          type:
            - string
            - 'null'
          description: Who set the value at the level in effect.
          example: KODE OS
        relinquishDefault:
          type: boolean
          description: >-
            `true` when no level holds a value, so the point is at its
            relinquish default.
          example: false
  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.