Skip to main content
GET
GET /v1/tables/{id}

Retrieve a Table

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

Get by ID

string
required
UUID of the table to retrieve.
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.
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.
string
required
Fully qualified name of the table (e.g., snowflake_prod.analytics.public.customers).
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.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/tables/{id}

Returns

Returns a table object with all requested fields populated.

Response

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

Error Handling