Describe a record table

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

get/v1/records/{object}/fields

Request

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

Path parameters

objectstring required

The record table: contacts, companies or deals (or a custom table).

Response

Default Response

default_match_onstring[]
descriptionstring nullable
idstring
kind'custom'
objectstring
searchableboolean
soft_deleteboolean
sort_keysstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.