API Documentation
Organization -> Organizations
Organization -> Workspaces
Organization -> Projects
Projects (Deprecated)
Projects -> Api Key
Connections
Data -> Catalogs
Data -> Internal Tables
Data -> Queries
Data -> Semantic Catalogs
Data -> Cache
Embedded Peaka Api
Supported Drivers
Data -> Metadata
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the the column.
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- DELDelete golden sql from the project.
Data -> Catalogs
List Columns
GET
/
data
/
projects
/
{projectId}
/
catalogs
/
{catalogId}
/
schemas
/
{schemaName}
/
tables
/
{tableName}
/
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
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the project
ID of the catalog
Name of the schema
Name of the table
Response
200 - application/json
Successful operation
The response is of type object[]
.
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
}
]