Skip to main content
GET
/
data
/
projects
/
{projectId}
/
table
List Tables
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/table \
  --header 'Authorization: Bearer <token>'
[
  {
    "catalogId": "<string>",
    "catalogName": "<string>",
    "schemaName": "<string>",
    "tableName": "<string>",
    "isCacheable": true,
    "isDynamicTable": true,
    "isCached": true
  }
]

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

Response

200 - */*

OK

​
catalogId
string

The ID of the catalog that the table belongs to.

​
catalogName
string

The name of the catalog that the table belongs to.

​
schemaName
string

The name of the schema that the table belongs to.

​
tableName
string

The name of the table.

​
isCacheable
boolean

Indicates whether the table is cacheable or not.

​
isDynamicTable
boolean

Indicates whether the table has required query parameter columns or not. A query parameter column is prefixed with "q" e.g. "_q_date". These columns are used to filter the data in the table.

​
isCached
boolean

Indicates whether the table is cached or not. It is not the status of caching.
e.g. when a table is cached, you are no longer accessing the original data source. But the data may not be complete since an ongoing cache refresh is in progress.