Skip to main content
GET
/
data
/
projects
/
{projectId}
/
catalogs
/
{catalogId}
/
schemas
/
{schemaName}
/
tables
/
{tableName}
/
columns
List Columns
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/columns \
  --header 'Authorization: Bearer <token>'
[
  {
    "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
  }
]

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

​
catalogId
string
required

ID of the catalog

​
schemaName
string
required

Name of the schema

​
tableName
string
required

Name of the table

Response

200 - application/json

Successful operation

​
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.