> ## 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 points in a point group

> Returns the points that belong to one point group, each with its current field and enum-mapping status. Use it to review a group before you apply a plan, or to pick single points.

Send the same `deviceIds` you used to discover the group, and the `groupKey` from the discovery response. Repeat the `deviceIds` parameter once for each device. Because the ids go in the URL, a very long list can exceed the request-line limit. Discover and drill into the devices in smaller batches if you reach it.

Each point shows the `field`, `displayName`, `canonicalType`, `prefix`, and `suffix` it carries now, if it is templated. `enumStatus` shows whether its enum values are mapped. Use a point's `id` in the `pointIds` of a mapping to template that point apart from its group.

A `groupKey` that is malformed, or that matches no group of the selected devices, returns `400`. Virtual points are never listed.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/templating/point-groups/{groupKey}/points
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}/templating/point-groups/{groupKey}/points:
    get:
      tags:
        - Templating
      summary: List points in a point group
      description: >-
        Returns the points that belong to one point group, each with its current
        field and enum-mapping status. Use it to review a group before you apply
        a plan, or to pick single points.
      operationId: listTemplatingGroupPoints
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - description: >-
            The group's server-derived key (from the point-groups query
            response).
          name: groupKey
          in: path
          required: true
          schema:
            type: string
            pattern: '[^\p{C}\p{Z}]{1,128}'
            maxLength: 64
        - name: asc
          in: query
          schema:
            type: string
          description: Sort ascending by a point field, such as `name`.
        - description: >-
            Device ids to scope the group to. Send the same devices you used to
            discover the group. Repeat the parameter for each id. At least 1 and
            at most 2,000 ids.
          name: deviceIds
          in: query
          schema:
            type: array
            items:
              type: string
              pattern: '[^\p{C}\p{Z}]{1,128}'
              maxLength: 255
            maxItems: 2000
            minItems: 1
          required: true
        - name: dsc
          in: query
          schema:
            type: string
            default: _id
          description: Sort descending by a point field, such as `name`.
        - description: >-
            Comma-separated fields to return for each point. One or more of
            `id`, `name`, `deviceId`, `deviceName`, `kind`, `writable`,
            `unitSymbol`, `pointEnum`, `field`, `displayName`, `canonicalType`,
            `prefix`, `suffix`, and `enumStatus`. The default is every field. An
            unknown name returns `400`.
          name: fields
          in: query
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
            maximum: 200
            minimum: 1
            default: 50
          description: >-
            Maximum number of points to return, 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: q
          in: query
          schema:
            type: string
          description: Return only points whose name contains this text.
      responses:
        '200':
          description: A page of the group's points.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEntityTemplatingGroupPointPublic'
        '400':
          description: >-
            The `groupKey` is not valid or matches no group of the selected
            devices, `deviceIds` is missing, empty, or over 2,000 ids, or
            another parameter is not valid. The `fields` list in the error names
            each problem.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The service account lacks permission to view templating, or the
            building does not exist or is not assigned to it. KODE API answers
            `403` in both cases so that building ids cannot be probed.
        '404':
          $ref: '#/components/responses/NotFound'
        '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:
    PaginatedEntityTemplatingGroupPointPublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TemplatingGroupPointPublic'
        page:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        pageCount:
          type: integer
          format: int32
        itemCount:
          type: integer
          format: int32
    TemplatingGroupPointPublic:
      type: object
      properties:
        id:
          type: string
          description: Point id.
          examples:
            - 66f1a2b3c4d5e6f7a8b9c0d1
        name:
          type: string
          description: Point (connector) name.
          examples:
            - SA-T
        deviceId:
          type: string
          description: Owning device id.
          examples:
            - 66f1a2b3c4d5e6f7a8b9c0d2
        deviceName:
          type: string
          description: Owning device name.
          examples:
            - AHU-1
        kind:
          type: string
          description: Point kind, spelled as the engine stores it (Number, Bool or Str).
          examples:
            - Number
        writable:
          type: boolean
          description: Writable tri-state.
          examples:
            - false
        unitSymbol:
          type: string
          description: Unit symbol (Number kind only).
          examples:
            - °F
        pointEnum:
          type: array
          items:
            type: string
          description: Point enum values, in stored order (non-Number kinds only).
        field:
          type: string
          description: Field currently applied to this point, if templated.
          examples:
            - dischargeAirTemp
        displayName:
          type: string
          description: Field display name, if templated.
          examples:
            - Discharge Air Temp
        canonicalType:
          type: string
          description: Device canonical type, if templated.
          examples:
            - AHU
        prefix:
          type: integer
          format: int32
          description: Field-instance prefix.
          examples:
            - 0
        suffix:
          type: integer
          format: int32
          description: Field-instance suffix.
          examples:
            - 0
        enumStatus:
          $ref: '#/components/schemas/EnumStatusPublic'
          description: This point's enum-mapping status.
          type: string
          examples:
            - N_A
    EnumStatusPublic:
      type: string
      enum:
        - ENUM_STATUS_UNSPECIFIED
        - N_A
        - UNMAPPED
        - PARTIALLY_MAPPED
        - MAPPED
  responses:
    Unauthorized:
      description: The access token is missing, invalid, or expired. Request a new token.
    NotFound:
      description: The resource does not exist or is not assigned to the service account.
    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.