---
title: "Describe a record table"
method: GET
path: "/v1/records/{object}/fields"
---

# Describe a record table

`GET /v1/records/{object}/fields`

## Request

- Base URL: `https://api.pantheon.run`
- URL: `https://api.pantheon.run/v1/records/{object}/fields`
- Auth: HTTP bearer

The table's fields (types, writability, filter operators), sort keys and bulk-upsert match keys.

## Path parameters

- `object` string, required

## Response `200`

Default Response

- object
  - `default_match_on` string[]
  - `default_sort` object
    - `direction` string
    - `field` string
  - `description` string, nullable
  - `fields` object[]
    - `create_only` boolean
    - `description` string
    - `filter_ops` string[]
    - `key` string
    - `options` unknown[]
      - unknown
    - `primary` boolean
    - `reference` object
      - `multiple` boolean
      - `object` string
    - `required_on_create` boolean
    - `sortable` boolean
    - `type` string
    - `writable` boolean
  - `id` string
  - `kind` 'custom'
  - `label` object
    - `plural` string
    - `singular` string
  - `match_keys` object[]
    - `key` string
    - `opt_in` boolean
  - `object` string
  - `searchable` boolean
  - `soft_delete` boolean
  - `sort_keys` string[]

---

[API](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api.md) · [All operations](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api/revisions/e51924bd212a?raw)