Skip to main content
GET
/
data
/
projects
/
{projectId}
/
bitable
/
{tableName}
/
columns
List BI Columns
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "dataType": "<string>",
    "displayName": "<string>",
    "defaultValue": "<string>",
    "isNotNull": true,
    "isUnique": true,
    "desc": "<string>"
  }
]

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.

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' 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

Path Parameters

​
projectId
string
required

ID of the Project

​
tableName
string
required

Name of the BI table

Response

200 - */*

OK

​
id
string

The id of the column.

​
name
string

The name of the column.

​
dataType
string

The data type of the column.

​
displayName
string

The display name of the column.

​
defaultValue
string

The default value of the column.

​
isNotNull
boolean

The not null flag for the column.

​
isUnique
boolean

The unique flag for the column.

​
desc
string

The description of the column.