---
title: "Get Table Descriptions"
method: GET
path: "/table-descriptions"
tags: ["Table Description"]
---

# Get Table Descriptions

`GET /table-descriptions`

## Query parameters

- `table_name` string

## Response `200`

Successful Response

- TableDescriptionResponse[]
  - `id` string, required
  - `db_connection_id` string
  - `description` string
  - `columns` ColumnDescription[]
    - `name` string
    - `description` string
    - `is_primary_key` boolean
    - `data_type` string
    - `low_cardinality` boolean
    - `categories` string[]
    - `foreign_key` object
  - `examples` unknown[]
    - unknown
  - `table_name` string
  - `status` 'NOT_SYNCHRONIZED' | 'SYNCHRONIZING' | 'SYNCHRONIZED' | 'DEPRECATED' | 'FAILED' — An enumeration.
  - `last_schema_sync` string, date-time
  - `created_at` string, date-time
  - `metadata` TableDescriptionMetadata
    - `dh_internal` object

## Other responses

- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.dev/dataherald/apis/fastapi.md) · [All operations](https://skmtc.dev/dataherald/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dataherald/fastapi/revisions/e168e98625a8/schema)