---
title: "Get a Table Info"
method: GET
path: "/kvservice.describetable/{tableName}"
tags: ["Key-Value Store"]
---

# Get a Table Info

`GET /kvservice.describetable/{tableName}`

## Request

- Base URL: `https://companynode.pricefx.com/pricefx/companypartition`
- URL: `https://companynode.pricefx.com/pricefx/companypartition/kvservice.describetable/{tableName}`
- Auth: one of:
  - HTTP basic
  - API key in header `X-PriceFx-jwt`
- TypeScript: <https://skmtc.dev/pricefx/apis/the-pricefx-backend-api/docs/kvservice.describetable/:tableName/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves primary keys, column names, column types, and indexes of the specified table.

## Response `200`

OK

- object
  - `response` object
    - `node` string
    - `data` object[]
      - `primary_keys` string[]
      - `indexes` object[]
      - `columns` string[]
    - `status` integer

---

[API](https://skmtc.dev/pricefx/apis/the-pricefx-backend-api.md) - [All operations](https://skmtc.dev/pricefx/apis/the-pricefx-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pricefx/apis/the-pricefx-backend-api/revisions/23d941b00ac0?raw)