Skip to main content
GET
/
v1
/
tables
/
{id}
GET /v1/tables/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Tables

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
table = Tables.retrieve("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
print(f"{table.fullyQualifiedName}: {table.description}")

# Get by ID with fields
table = Tables.retrieve(
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    fields=["columns", "tags", "owners", "usageSummary"]
)

# Get by fully qualified name
table = Tables.retrieve_by_name("snowflake_prod.analytics.public.customers")

# Get by name with fields
table = Tables.retrieve_by_name(
    "snowflake_prod.analytics.public.customers",
    fields=["columns", "tags", "owners"]
)

{
  "id": "455e3d9d-dbbf-455e-b3be-7191daa825f3",
  "name": "agent_performance_summary",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary",
  "description": "Summary of agent performance metrics derived from multiple tables including ssot_utilization_detail for comprehensive reporting.",
  "version": 0.1,
  "updatedAt": 1769982651320,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3",
  "tableType": "Regular",
  "columns": [
    {
      "name": "agent_id",
      "dataType": "VARCHAR",
      "dataLength": 100,
      "dataTypeDisplay": "varchar",
      "description": "Agent identifier",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary.agent_id",
      "tags": [],
      "ordinalPosition": 1
    },
    {
      "name": "performance_score",
      "dataType": "DECIMAL",
      "dataTypeDisplay": "decimal",
      "description": "Overall performance score",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary.performance_score",
      "tags": [],
      "ordinalPosition": 2
    }
  ],
  "owners": [],
  "databaseSchema": {
    "id": "4dd30184-009c-4792-b296-9562eaed651f",
    "type": "databaseSchema",
    "name": "shopify",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify",
    "description": "This **mock** database contains schema related to shopify sales and orders with related dimension tables.",
    "displayName": "shopify",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databaseSchemas/4dd30184-009c-4792-b296-9562eaed651f"
  },
  "database": {
    "id": "0be090de-0941-48c4-af49-a6157c91cda0",
    "type": "database",
    "name": "ecommerce_db",
    "fullyQualifiedName": "sample_data.ecommerce_db",
    "description": "This **mock** database contains schemas related to shopify sales and orders with related dimension tables.",
    "displayName": "ecommerce_db",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databases/0be090de-0941-48c4-af49-a6157c91cda0"
  },
  "service": {
    "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
    "type": "databaseService",
    "name": "sample_data",
    "fullyQualifiedName": "sample_data",
    "displayName": "sample_data",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09"
  },
  "serviceType": "BigQuery",
  "tags": [],
  "deleted": false,
  "domains": [],
  "processedLineage": false,
  "entityStatus": "Unprocessed"
}

​
Retrieve a Table

Get a single table by its unique ID or fully qualified name.

​
Get by ID

​
id
string
required
UUID of the table to retrieve.
​
fields
string
Comma-separated list of fields to include. Valid fields: tableConstraints, tablePartition, usageSummary, owners, customMetrics, columns, sampleData, tags, followers, joins, schemaDefinition, dataModel, extension, testSuite, domains, dataProducts, lifeCycle, sourceHash.
​
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

​
Get by Fully Qualified Name

Use GET /v1/tables/name/{fqn} to retrieve by fully qualified name.
​
fqn
string
required
Fully qualified name of the table (e.g., snowflake_prod.analytics.public.customers).
​
fields
string
Comma-separated list of fields to include. Valid fields: tableConstraints, tablePartition, usageSummary, owners, customMetrics, columns, sampleData, tags, followers, joins, schemaDefinition, dataModel, extension, testSuite, domains, dataProducts, lifeCycle, sourceHash.
​
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/tables/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Tables

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
table = Tables.retrieve("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
print(f"{table.fullyQualifiedName}: {table.description}")

# Get by ID with fields
table = Tables.retrieve(
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    fields=["columns", "tags", "owners", "usageSummary"]
)

# Get by fully qualified name
table = Tables.retrieve_by_name("snowflake_prod.analytics.public.customers")

# Get by name with fields
table = Tables.retrieve_by_name(
    "snowflake_prod.analytics.public.customers",
    fields=["columns", "tags", "owners"]
)

{
  "id": "455e3d9d-dbbf-455e-b3be-7191daa825f3",
  "name": "agent_performance_summary",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary",
  "description": "Summary of agent performance metrics derived from multiple tables including ssot_utilization_detail for comprehensive reporting.",
  "version": 0.1,
  "updatedAt": 1769982651320,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/tables/455e3d9d-dbbf-455e-b3be-7191daa825f3",
  "tableType": "Regular",
  "columns": [
    {
      "name": "agent_id",
      "dataType": "VARCHAR",
      "dataLength": 100,
      "dataTypeDisplay": "varchar",
      "description": "Agent identifier",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary.agent_id",
      "tags": [],
      "ordinalPosition": 1
    },
    {
      "name": "performance_score",
      "dataType": "DECIMAL",
      "dataTypeDisplay": "decimal",
      "description": "Overall performance score",
      "fullyQualifiedName": "sample_data.ecommerce_db.shopify.agent_performance_summary.performance_score",
      "tags": [],
      "ordinalPosition": 2
    }
  ],
  "owners": [],
  "databaseSchema": {
    "id": "4dd30184-009c-4792-b296-9562eaed651f",
    "type": "databaseSchema",
    "name": "shopify",
    "fullyQualifiedName": "sample_data.ecommerce_db.shopify",
    "description": "This **mock** database contains schema related to shopify sales and orders with related dimension tables.",
    "displayName": "shopify",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databaseSchemas/4dd30184-009c-4792-b296-9562eaed651f"
  },
  "database": {
    "id": "0be090de-0941-48c4-af49-a6157c91cda0",
    "type": "database",
    "name": "ecommerce_db",
    "fullyQualifiedName": "sample_data.ecommerce_db",
    "description": "This **mock** database contains schemas related to shopify sales and orders with related dimension tables.",
    "displayName": "ecommerce_db",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/databases/0be090de-0941-48c4-af49-a6157c91cda0"
  },
  "service": {
    "id": "fd2193af-fe09-4366-92b7-1e0d01cd8c09",
    "type": "databaseService",
    "name": "sample_data",
    "fullyQualifiedName": "sample_data",
    "displayName": "sample_data",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09"
  },
  "serviceType": "BigQuery",
  "tags": [],
  "deleted": false,
  "domains": [],
  "processedLineage": false,
  "entityStatus": "Unprocessed"
}

​
Returns

Returns a table object with all requested fields populated.

​
Response

​
id
string
Unique identifier for the table (UUID format).
​
name
string
Table name.
​
fullyQualifiedName
string
Fully qualified name in format service.database.schema.table.
​
displayName
string
Human-readable display name.
​
description
string
Description of the table in Markdown format.
​
tableType
string
Type of table.
​
columns
array
Column definitions with fully qualified names.
​
databaseSchema
object
Reference to the parent database schema.
​
service
object
Reference to the parent database service.
​
serviceType
string
Type of database service.
​
version
number
Version number for the entity.
​
owners
array
List of owners. Only included when fields contains owners.
​
tags
array
Classification tags. Only included when fields contains tags.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this table
404NOT_FOUNDTable with given ID or FQN does not exist