> ## 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 Columns
> Lists all columns for a specific table within a catalog. Returns full column metadata including name, data type, display name, default value, and constraints (nullability, uniqueness). Some connectors expose additional virtual columns (prefixed with `_q_`) that can be used to pass query-time parameters to the data source.
## OpenAPI
````yaml get /data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{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}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/columns:
get:
tags:
- Data -- Catalogs
summary: List Columns
description: >-
Lists all columns for a specific table within a catalog. Returns full
column metadata including name, data type, display name, default value,
and constraints (nullability, uniqueness). Some connectors expose
additional virtual columns (prefixed with `_q_`) that can be used to
pass query-time parameters to the data source.
operationId: listColumns_1
parameters:
- name: projectId
in: path
description: ID of the project
required: true
schema:
type: string
example: mtKDhe1U
- name: catalogId
in: path
description: ID of the catalog
required: true
schema:
type: string
example: 846085284821991600
- name: schemaName
in: path
description: Name of the schema
required: true
schema:
type: string
example: public
- name: tableName
in: path
description: Name of the table
required: true
schema:
type: string
example: actor
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ColumnDetail'
examples:
List Columns:
description: List Columns
value:
- name: id
dataType: bigint
displayName: id
defaultValue: null
isNotNull: false
isUnique: false
- name: hs_object_id
dataType: varchar
displayName: hs_object_id
defaultValue: null
isNotNull: false
isUnique: false
- name: email
dataType: varchar
displayName: email
defaultValue: null
isNotNull: false
isUnique: false
- name: name
dataType: varchar
displayName: name
defaultValue: null
isNotNull: false
isUnique: false
- name: domain
dataType: varchar
displayName: domain
defaultValue: null
isNotNull: false
isUnique: false
- name: industry
dataType: varchar
displayName: industry
defaultValue: null
isNotNull: false
isUnique: false
- name: phone
dataType: varchar
displayName: phone
defaultValue: null
isNotNull: false
isUnique: false
- name: country
dataType: varchar
displayName: country
defaultValue: null
isNotNull: false
isUnique: false
- name: state
dataType: varchar
displayName: state
defaultValue: null
isNotNull: false
isUnique: false
- name: city
dataType: varchar
displayName: city
defaultValue: null
isNotNull: false
isUnique: false
- name: description
dataType: varchar
displayName: description
defaultValue: null
isNotNull: false
isUnique: false
- name: createdate
dataType: timestamp(6)
displayName: createdate
defaultValue: null
isNotNull: false
isUnique: false
- name: hs_lastmodifieddate
dataType: timestamp(6)
displayName: hs_lastmodifieddate
defaultValue: null
isNotNull: false
isUnique: false
- name: properties
dataType: json
displayName: properties
defaultValue: null
isNotNull: false
isUnique: false
- name: propertieswithhistory
dataType: json
displayName: propertieswithhistory
defaultValue: null
isNotNull: false
isUnique: false
- name: createdat
dataType: timestamp(6)
displayName: createdat
defaultValue: null
isNotNull: false
isUnique: false
- name: updatedat
dataType: timestamp(6)
displayName: updatedat
defaultValue: null
isNotNull: false
isUnique: false
- name: archived
dataType: boolean
displayName: archived
defaultValue: null
isNotNull: false
isUnique: false
- name: archivedat
dataType: timestamp(6)
displayName: archivedat
defaultValue: null
isNotNull: false
isUnique: false
- name: associations
dataType: json
displayName: associations
defaultValue: null
isNotNull: false
isUnique: false
- name: _q_pagination_anchor
dataType: varchar
displayName: _q_pagination_anchor
defaultValue: null
isNotNull: false
isUnique: false
- name: _q_limit
dataType: bigint
displayName: _q_limit
defaultValue: null
isNotNull: false
isUnique: false
- name: _q_offset
dataType: varchar
displayName: _q_offset
defaultValue: null
isNotNull: false
isUnique: false
- name: _q_properties
dataType: json
displayName: _q_properties
defaultValue: null
isNotNull: false
isUnique: false
- name: _q_properties_with_history
dataType: varchar
displayName: _q_properties_with_history
defaultValue: null
isNotNull: false
isUnique: false
- name: _q_associations
dataType: varchar
displayName: _q_associations
defaultValue: null
isNotNull: false
isUnique: false
- name: _q_archived
dataType: boolean
displayName: _q_archived
defaultValue: null
isNotNull: false
isUnique: false
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 ' 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
````