> ## 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 action fields

> Returns the fields an action accepts. Use the response to build the request body for invoking the action.



## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/integrations/datasources/{datasourceId}/actions/{action}/fields
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/datasources/{datasourceId}/actions/{action}/fields:
    get:
      tags:
        - Actions
      summary: List action fields
      description: >-
        Returns the fields an action accepts. Use the response to build the
        request body for invoking the action.
      operationId: listActionFields
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - $ref: '#/components/parameters/DatasourceId'
        - $ref: '#/components/parameters/Action'
      responses:
        '200':
          description: Fields for the action.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldDefinition'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '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
    DatasourceId:
      name: datasourceId
      in: path
      required: true
      description: Data source identifier from List building data sources.
      schema:
        type: string
      example: 67c97396a0fceb379fc4ec08
    Action:
      name: action
      in: path
      required: true
      description: Action name from List data source actions.
      schema:
        type: string
      example: DISCOVER
  schemas:
    FieldDefinition:
      type: object
      description: Describes one field you can send in an `actions` array.
      properties:
        identifier:
          type: string
          description: Value to send as `actions[].id`.
          example: priority
        name:
          type: string
          example: priority
        displayName:
          type: string
          example: Priority
        dataType:
          type: string
          example: STRING
        inputType:
          type: string
          example: DROP_DOWN
        defaultValue:
          type: string
          example: override
        order:
          type: integer
          example: 1
        options:
          type: array
          description: Allowed values. Send the option `_id`.
          items:
            type: object
            properties:
              _id:
                type: string
                example: override
              name:
                type: string
                example: Override
        metadata:
          type: object
          properties:
            required:
              type: string
              enum:
                - MANDATORY
                - OPTIONAL
                - CONDITIONAL
              example: MANDATORY
            isDisabled:
              type: boolean
            isHidden:
              type: boolean
            filter:
              type: object
              description: Condition that makes a `CONDITIONAL` field apply.
              properties:
                conjunction:
                  type: string
                  example: AND
                filterSet:
                  type: array
                  items:
                    type: object
                    properties:
                      fieldName:
                        type: string
                        example: priority
                      operator:
                        type: string
                        example: IN
                      value:
                        type: array
                        items:
                          type: string
                        example:
                          - override
                          - set
  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.
    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.