> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peaka.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List BI Columns

> Lists all columns defined in the specified [Peaka BI Table](https://docs.peaka.com/connecting-your-data/peaka-bi-table). Returns column metadata including name, data type, display name, default value, and constraints such as nullability and uniqueness. Note that Peaka BI Table does not support JSON data types.

<span style={{display: "flex", gap: "10px", flexDirection: "row", alignItems: "center"}}>
  <img src="https://cdn.peaka.com/badges/partner-api-key-badge.png" />

  <img src="https://cdn.peaka.com/badges/project-api-key-badge.png" />
</span>


## OpenAPI

````yaml get /data/projects/{projectId}/bitable/{tableName}/columns
openapi: 3.0.1
info:
  title: Peaka Gateway API
  description: Peaka Gateway API Documentation
  version: '1.0'
servers:
  - url: https://partner.peaka.studio/api/v1
    description: Default Server URL (US Zone)
  - url: https://partner.eu.peaka.studio/api/v1
    description: EU Zone
security:
  - bearerAuth: []
paths:
  /data/projects/{projectId}/bitable/{tableName}/columns:
    get:
      tags:
        - Data -- Internal Tables
      summary: List BI Columns
      description: >-
        Lists all columns defined in the specified [Peaka BI
        Table](https://docs.peaka.com/connecting-your-data/peaka-bi-table).
        Returns column metadata including name, data type, display name, default
        value, and constraints such as nullability and uniqueness. Note that
        Peaka BI Table does not support JSON data types.
      operationId: listBiColumns
      parameters:
        - name: projectId
          in: path
          description: ID of the Project
          required: true
          schema:
            type: string
          example: mtKDhe1U
        - name: tableName
          in: path
          description: Name of the BI table
          required: true
          schema:
            type: string
          example: events
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ColumnDetail'
components:
  schemas:
    ColumnDetail:
      type: object
      properties:
        id:
          type: string
          description: The id of the column.
        name:
          type: string
          description: The name of the column.
        dataType:
          type: string
          description: The data type of the column.
        displayName:
          type: string
          description: The display name of the column.
        defaultValue:
          type: string
          description: The default value of the column.
        isNotNull:
          type: boolean
          description: The not null flag for the column.
        isUnique:
          type: boolean
          description: The unique flag for the column.
        desc:
          type: string
          description: The description of the column.
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Use the Authorization header with the value 'Bearer <apiKey>' to
        authenticate. Partner API Keys have full access; Project API Keys are
        limited to their project scope. Learn more:
        https://docs.peaka.com/api-reference/authentication
      scheme: bearer
      bearerFormat: Api Key

````